Compare commits

...
Author SHA1 Message Date
alwayscompiling 0eb332aefd Added verify and submission register subcommands. Removed bot argument from Register class. 2022-08-06 22:21:08 -04:00
alwayscompiling ff07787a9a Create register group and highscore slash subcommand. 2022-08-06 20:14:30 -04:00
alwayscompiling b5959ccc33 Change constructor of score. Create new function to add score value from a string. 2022-08-06 17:32:17 -04:00
alwayscompiling b80f160914 Update verification view to use Table instead of Boss. 2022-08-06 16:55:06 -04:00
alwayscompiling 3b866be3ab Corrected typo in submission_state setter. 2022-08-06 16:45:05 -04:00
alwayscompiling e55b22c821 Easier to read submission access. 2022-08-06 16:41:50 -04:00
alwayscompiling f06e6f1e1e Create function to know if a user has a submission. 2022-08-06 16:30:49 -04:00
alwayscompiling 5f3e7361b4 Convert old submission_objects to new class. 2022-08-06 16:30:31 -04:00
alwayscompiling 835611a11e Created submission classes. 2022-08-06 16:10:19 -04:00
alwayscompiling ee9a23ca79 Renamed data folder to classes. 2022-08-06 14:59:58 -04:00
alwayscompiling 448bed17ec Have to pass guild object to save function. 2022-08-04 11:34:51 -04:00
alwayscompiling b4d0f8a15e Save data after posting messages. 2022-08-04 11:22:50 -04:00
alwayscompiling 72a97f6cb7 Correct config creation. 2022-08-04 11:15:27 -04:00
alwayscompiling 8aadf07968 Added asending and time record setters. 2022-08-04 11:06:36 -04:00
alwayscompiling a6f98d11ab Added temporary config handling. 2022-08-04 11:06:18 -04:00
alwayscompiling 4ee0593619 Edit category constructor to allow for empty objects. 2022-08-04 10:38:45 -04:00
alwayscompiling d4db9b51f0 Moved table size to table class. Edited table constructor. 2022-08-04 10:33:34 -04:00
alwayscompiling f67eb75c7b Add warning for posting without tables. 2022-08-04 10:29:14 -04:00
alwayscompiling 6f4322bf6a Added a to_str function for all classes. __str__ function uses it. highscores_data uses the to_str function for saving. 2022-08-03 22:35:27 -04:00
alwayscompiling 66ace947c6 Saving guild after modification. 2022-08-03 22:21:49 -04:00
alwayscompiling 4d9c70bf09 Update saving functions. 2022-08-03 22:16:43 -04:00
alwayscompiling 4c944c8323 pylint line length. 2022-08-03 20:08:32 -04:00
alwayscompiling b65254c2cc Runtime error fixes. 2022-08-03 20:03:48 -04:00
alwayscompiling 5b3c9ef247 Somehow didn't finish guilds function. 2022-08-03 19:32:37 -04:00
alwayscompiling 027da38574 Update utils function args to use new data classes instead of various args. 2022-08-03 19:28:47 -04:00
alwayscompiling 80e4602621 Update submissin cog to new data class. Also clean up import lists. 2022-08-02 21:52:12 -04:00
alwayscompiling 07310c804a Remove score command. It isn't used. 2022-08-02 21:41:13 -04:00
alwayscompiling 4641ce4048 Update register command to use data class. 2022-08-02 21:40:27 -04:00
alwayscompiling 142842a36b Update post highscores to new data class. 2022-08-02 21:36:17 -04:00
alwayscompiling 6371fc4e8c Update message listener to new data classes. 2022-08-02 21:29:57 -04:00
alwayscompiling 3fac5f7a06 Update guild listener command to new data classes. 2022-08-02 21:23:16 -04:00
alwayscompiling 80f3966d39 Update delete scores command. 2022-08-02 21:21:36 -04:00
alwayscompiling 69a439d13a Correct message map creation. 2022-08-02 16:43:15 -04:00
alwayscompiling 251ac2cf47 Update highscores.py to use new data classes. 2022-08-02 16:41:46 -04:00
alwayscompiling 2dc0350213 Idk how the merge messed up, but fixed the bad merge. 2022-08-02 16:36:50 -04:00
alwayscompiling 7e40937cdd Merge branch '25-data-class' of github.com:alwayscompiling/pvm-highscores into 25-data-class 2022-08-02 16:33:35 -04:00
alwayscompiling 761a7df29f Constructor and string function fixes. Ignored new data dir. 2022-08-02 16:30:30 -04:00
alwayscompiling b3a84fc3a8 Add str function for highscores data. 2022-08-02 16:20:56 -04:00
alwayscompiling 262bcd07b9 Update highscores_data to be an overarching class for all data. 2022-08-02 16:16:45 -04:00
alwayscompiling 8ca77d93b3 Update highscores_data to be an overarching class for all data. 2022-08-02 16:13:08 -04:00
alwayscompiling 1b4f0362b5 Renamed runescape example config. 2022-08-01 22:50:01 -04:00
alwayscompiling ce60288892 Add highscore size to guild class. 2022-08-01 22:48:23 -04:00
alwayscompiling 2515b90497 redo guild docstrings. 2022-08-01 22:38:32 -04:00
alwayscompiling 3ce9f8090f Correct from dict wording. 2022-08-01 22:29:30 -04:00
alwayscompiling 68da97e138 Redo table docstrings. 2022-08-01 22:23:38 -04:00
alwayscompiling ef28b97a1b get user score was using wrong variable. 2022-08-01 22:22:16 -04:00
alwayscompiling e43a0a8977 Redo category docstrings. 2022-08-01 22:17:52 -04:00
alwayscompiling 2ee2d3405e Redo score docstrings. 2022-08-01 22:06:54 -04:00
alwayscompiling af204a3156 Correct sort scores value. 2022-08-01 21:56:23 -04:00
alwayscompiling 109b22be62 Add get_table function. 2022-08-01 21:21:57 -04:00
alwayscompiling aa4b06c125 Correct return type of tables. 2022-08-01 21:17:26 -04:00
alwayscompiling 96fce1d661 Clarified to_dict function description. 2022-08-01 21:12:46 -04:00
alwayscompiling 3d471198f5 Created rest of guild functions. 2022-08-01 21:09:03 -04:00
alwayscompiling 05d0653a5b Create guild class. 2022-07-31 22:45:57 -04:00
alwayscompiling 6758f4e90d Changing from_dict to classmethod. 2022-07-31 22:14:53 -04:00
alwayscompiling 6e6b57c49c Create table class. 2022-07-31 12:07:07 -04:00
alwayscompiling b4f72b9528 Renamed scores to scores_map to avoid confusion. 2022-07-31 11:51:50 -04:00
alwayscompiling cd81ee3140 Change score score to be score value. 2022-07-31 10:57:45 -04:00
alwayscompiling 6ddba14908 Change str function to use json string dump. 2022-07-31 10:19:23 -04:00
alwayscompiling 0fc0fc33da Filled out to and from dict functions and a few others. 2022-07-30 23:12:40 -04:00
alwayscompiling 529761b45f Remove optional on score. 2022-07-30 22:43:11 -04:00
alwayscompiling bac64110c1 Add category class. 2022-07-30 22:31:40 -04:00
alwayscompiling d04de253e7 Add str function. 2022-07-30 22:15:58 -04:00
alwayscompiling 8c7a801800 Small description change. 2022-07-30 21:58:10 -04:00
alwayscompiling 01df80d358 Correcting time string. 2022-07-30 21:53:29 -04:00
alwayscompiling 06248cfe6c Using property decorators. 2022-07-30 21:12:36 -04:00
alwayscompiling a3af93d4bc Create Score class. 2022-07-30 17:09:44 -04:00
alwayscompiling 646ee0274b Move highscores_data to new location. 2022-07-30 16:34:33 -04:00
alwayscompiling fe0a74cfc4 Extend submission timeout. Remove submission object on submission timeout. Also Let user know when it isn't their submission. 2022-07-30 16:19:44 -04:00
alwayscompiling 5bed587da9 Fixing configs for elite dungeon bosses. 2022-07-30 10:56:21 -04:00
alwayscompiling f7a40f83a9 Birthday troll. 2022-07-29 22:45:40 -04:00
alwayscompiling a66bc4982f on_guild_join needs 2 parameters. 2022-07-29 22:45:21 -04:00
21 changed files with 1436 additions and 634 deletions
+1 -1
View File
@@ -132,6 +132,6 @@ nextcord.log
# data file for bot # data file for bot
highscores_data.json highscores_data.json
highscores_message_map.json
highscores_config.json highscores_config.json
deleted_backups/ deleted_backups/
highscores_data/
+190
View File
@@ -0,0 +1,190 @@
"""File for Category class."""
import json
from classes.score import Score, ScoreTime # pylint: disable=import-error
class Category:
"""Stores a category's information and relative scores."""
def __init__(self, name: str) -> None:
"""
Default constructor for Category class. Creates empty category and populates with defaults.
Args:
name (str): Category's name
"""
self._name: str = name
self._ascending: bool = False
self._time_record: bool = False
self._scores_map: dict = {}
def __str__(self) -> str:
"""
Returns Category class as a string for printing.
Returns:
str: Category class as a string
"""
return self.to_str()
@classmethod
def from_dict(cls, name: str, data: dict):
"""
Creates a Category class from the passed data.
Args:
name (str): Category name
data (dict): Rest of Category data in dictionary format
Returns:
Category: Populated Category object
"""
category = cls(name)
category.ascending = data["ascending"]
category.time_record = data["time_record"]
for user, score in data["scores"].items():
if category.time_record:
score_obj: ScoreTime = ScoreTime(user)
score_obj.value = float(score)
category.add_score(score_obj)
else:
score_obj: Score = Score(user)
score_obj.value = int(score)
category.add_score(score_obj)
return category
@property
def ascending(self) -> bool:
"""
Getter for is ascending.
Returns:
bool: is ascending
"""
return self._ascending
@ascending.setter
def ascending(self, ascending: bool) -> None:
"""
Setter for is ascending.
Args:
ascending (bool): is ascending
"""
self._ascending = ascending
@property
def name(self) -> str:
"""
Getter for name.
Returns:
str: name
"""
return self._name
@property
def time_record(self) -> bool:
"""
Getter for is time record.
Returns:
bool: is time record
"""
return self._time_record
@time_record.setter
def time_record(self, time_record: bool) -> None:
"""
Setter for is time record.
Args:
time_record (bool): is time record
"""
self._time_record = time_record
@property
def scores(self) -> "list[Score]":
"""
Getter for Scores list.
Returns:
list[Score]: List of Scores in this Category
"""
return self._scores_map.values()
def add_score(self, score: Score) -> None:
"""
Adds score to dictionary storage map. Sorts dictionary by score value.
Args:
score (Score): Score to be added
"""
if score.user in self._scores_map:
self._scores_map[score.user].value = score.value
else:
self._scores_map[score.user] = score
self._scores_map = dict(
sorted(self._scores_map.items(), key=lambda x: x[1].value, reverse=not self.ascending)
)
def clear(self) -> None:
"""
Clears all Scores tracked in score map.
This is a test function and shouldn't really be used.
"""
self._scores_map.clear()
def get_user_score(self, user: str) -> Score:
"""
Gets a user's score. Returns None if user is not found.
Args:
user (str): Name of score to find
Returns:
Score: User's Score or None
"""
if user in self._scores_map:
return self._scores_map[user]
return None
def remove_score(self, score: str) -> None:
"""
Removes a user's score from dictionary storage.
Args:
score (str): user whose score to remove
"""
score = self._scores_map.pop(score)
del score
def to_dict(self) -> dict:
"""
Saves category data as a python dictionary.
Does not include category name. It should be the key of above data structure.
Returns:
dict: Category class in dictionary format
"""
data = {}
data["ascending"] = self.ascending
data["time_record"] = self.time_record
data["scores"] = {}
for score in self.scores:
data["scores"][score.user] = score.value
return data
def to_str(self) -> str:
"""
Returns Category object as a string.
Returns:
str: string of json representation of Category
"""
return json.dumps(self.to_dict(), indent=4)
+211
View File
@@ -0,0 +1,211 @@
"""File for Guild class."""
import json
from classes.table import Table # pylint: disable=import-error
class Guild:
"""Stores a guild's information."""
def __init__(self, guild_id: int) -> None:
"""
Default constructor for Guild class. Initializes channel ids as 0 as they won't be
registered yet. Sets default username length of 12. Default highscores size to 3.
Args:
guild_id (int): Discord Guild id of new Guild
"""
self._guild_id: int = guild_id
self._highscore_channel_id: int = 0
self._submission_channel_id: int = 0
self._table_map: dict = {}
self._username_length: int = 12
self._verification_channel_id: int = 0
def __str__(self) -> str:
"""
Returns Guild class as a string for printing.
Returns:
str: Guild class as a string
"""
return self.to_str()
@classmethod
def from_dict(cls, guild_id: int, data: dict):
"""
Creates a Guild class from the passed data.
Args:
guild_id (int): Guild's id
data (dict): Rest of Guild data in dictionary format
Returns:
Guild: Populated Guild object
"""
guild = cls(guild_id)
guild.highscore_channel = data["highscore_channel_id"]
guild.submission_channel = data["submission_channel_id"]
guild.username_length = data["username_length"]
guild.verification_channel = data["verification_channel_id"]
for table_name, table_data in data["tables"].items():
table = Table.from_dict(table_name, table_data)
guild.add_table(table)
return guild
@property
def guild_id(self) -> int:
"""
Getter for Guild id
Returns:
int: Guild id
"""
return self._guild_id
@property
def highscore_channel(self) -> int:
"""
Getter for highscore channel id.
Returns:
int: highscore channel id
"""
return self._highscore_channel_id
@highscore_channel.setter
def highscore_channel(self, channel: int) -> None:
"""
Setter for highscore channel id.
Args:
channel (int): highscore channel id
"""
self._highscore_channel_id = channel
@property
def submission_channel(self) -> int:
"""
Getter for submission channel id.
Returns:
int: submission channel id
"""
return self._submission_channel_id
@submission_channel.setter
def submission_channel(self, channel: id) -> None:
"""
Setter fro submission channel id.
Args:
channel (id): submission channel id
"""
self._submission_channel_id = channel
@property
def tables(self) -> "list[Table]":
"""
Getter for Tables list.
Returns:
list[Table]: List of Tables in this Guild
"""
return self._table_map.values()
@property
def username_length(self) -> int:
"""
Getter for username length.
Returns:
int: username length
"""
return self._username_length
@username_length.setter
def username_length(self, length: int) -> None:
"""
Setter for username length.
Args:
length (int): username length
"""
self._username_length = length
@property
def verification_channel(self) -> int:
"""
Getter for verification channel id.
Returns:
int: verification channel id
"""
return self._verification_channel_id
@verification_channel.setter
def verification_channel(self, channel: int) -> None:
"""
Setter for verification channel id
Args:
channel (int): verification channel id
"""
self._verification_channel_id = channel
def add_table(self, table: Table) -> None:
"""
Adds a Table to table map. Shouldn't exist already.
Args:
table (Table): new Table to add
"""
if table.name not in self._table_map:
self._table_map[table.name] = table
def get_table(self, table_name: str) -> Table:
"""
Getter for specific Table. Returns None if Table is not found.
Args:
table_name (str): Name of Table to find
Returns:
Table: Table corresponding to Name. None if not found.
"""
if table_name in self._table_map:
return self._table_map[table_name]
return None
def to_dict(self) -> dict:
"""
Creates python dictionary object from class data.
Does not include guild_id in dict, it should be the key of above data structure.
Returns:
dict: Guild class in dictionary format
"""
data: dict = {}
data["highscore_channel_id"] = self.highscore_channel
data["submission_channel_id"] = self.submission_channel
data["tables"] = {}
data["username_length"] = self.username_length
data["verification_channel_id"] = self.verification_channel
for table in self.tables:
data["tables"][table.name] = table.to_dict()
return data
def to_str(self) -> str:
"""
Returns Guild object as a string.
Returns:
str: string of json representation of Guild
"""
return json.dumps(self.to_dict(), indent=4)
+153
View File
@@ -0,0 +1,153 @@
"""Class and functions for storing and retrieving highscores data."""
import os
import json
from classes.guild import Guild # pylint: disable=import-error
from classes.table import Table # pylint: disable=import-error
from classes.category import Category # pylint: disable=import-error
HIGHSCORES_BACKUP_DIR = "deleted_backups"
HIGHSCORES_CONFIG_DIR = "example_config"
HIGHSCORES_DATA_DIR = "highscores_data"
class HighscoresData:
"""Class for storing and retrieving highscores data."""
def __init__(self) -> None:
"""
Default constructor for Highscores Data. Opens up known highscores data on creation.
"""
self._guild_map: dict = {}
# Ensure that data directories exist.
if not os.path.exists(HIGHSCORES_BACKUP_DIR):
os.mkdir(HIGHSCORES_BACKUP_DIR)
if not os.path.exists(HIGHSCORES_DATA_DIR):
os.mkdir(HIGHSCORES_DATA_DIR)
self.open_highscores_data()
def __str__(self) -> str:
"""
Returns Highscores class as a string for printing.
Returns:
str: Highscores class as a string
"""
data: dict = {}
for guild_id, guild_obj in self._guild_map.items():
data[guild_id] = guild_obj.to_dict()
return "Highscores Data\n" + json.dumps(data, indent=4)
@property
def guilds(self) -> "list[Guild]":
"""
Getter for Guilds list.
Returns:
list[Guild]: List of Guilds tracked by Highscores Bot
"""
return self._guild_map.values()
def add_configuration(self, guild_id: int, config_str: str) -> None:
"""
Adds an example configuration to a Guild. Uses guild id to know which guild and
config name to open a file in example_config.
Args:
guild_id (int): Guild id to add config to
config_str (str): Config name to add
"""
config = self._open_highscores_config(config_str)
guild = self.get_guild(guild_id)
for table_name, categorys in config["tables"].items():
table_obj = Table(table_name)
table_obj.size = config["table_size"]
for category_name in categorys:
category = Category(category_name)
category.ascending = config["categories"][category.name]["ascending"]
category.time_record = config["categories"][category.name]["is_time_record"]
table_obj.add_category(category)
guild.add_table(table_obj)
def add_guild(self, guild_id: int) -> None:
"""
Creates a new Guild and adds to Guild map.
Args:
guild_id (int): Guild Id to add
"""
guild: Guild = Guild(guild_id)
self._guild_map[guild_id] = guild
def get_guild(self, guild_id: int) -> Guild:
"""
Getter for Guild object that corresponds with the guild_id.
Args:
guild_id (int): id of Guild to retrieve.
Returns:
Guild: Guild object for guild_id
"""
return self._guild_map[guild_id]
def remove_guild(self, guild_id: int) -> None:
"""
Removes a guild's data from object. Saves backup.
Args:
guild_id (int): guild id to remove
"""
self._guild_map.pop(guild_id)
os.rename(
f"{HIGHSCORES_DATA_DIR}/{guild_id}.json", f"{HIGHSCORES_BACKUP_DIR}/{guild_id}.json"
)
def _open_highscores_config(self, config: str) -> dict:
"""
Opens the highscores config file and returns in dictionary format.
Will be replaced when config class is created.
Args:
config (str): Name of config to load.
Returns:
dict: dict of highscores config
"""
with open(f"{HIGHSCORES_CONFIG_DIR}/{config}.json", encoding="utf-8", mode="r") as file:
return json.load(file)
def open_highscores_data(self):
"""
Opens all saved highscores data in the HIGHSCORES_DATA_DIR dir. Creates a Guild object from
each file and adds to guild map.
"""
for data_file in os.listdir(HIGHSCORES_DATA_DIR):
guild_id: int = int(data_file.split(".", maxsplit=1)[0])
with open(f"{HIGHSCORES_DATA_DIR}/{data_file}", encoding="utf-8", mode="r") as file:
guild_obj: Guild = Guild.from_dict(guild_id, json.load(file))
self._guild_map[guild_obj.guild_id] = guild_obj
def save_all_data(self) -> None:
"""
Calls save_guild_data for each guild tracked in guild map.
"""
for guild in self.guilds:
self.save_guild_data(guild)
def save_guild_data(self, guild: Guild) -> None:
"""
Saves a guild to its own json file.
Args:
guild (Guild): Guild to save
"""
with open(
f"{HIGHSCORES_DATA_DIR}/{guild.guild_id}.json", encoding="utf-8", mode="w"
) as file:
file.write(guild.to_str()) # should use str function
+144
View File
@@ -0,0 +1,144 @@
"""File for Score classes"""
import time
class Score:
"""Parent class for Scores. Stores common information for a Score."""
# no user setter, it should never change.
def __init__(self, user: str) -> None:
"""
Default constructor for Score class.
Args:
user (str): Score's user
value (int): Score's value
"""
self._user: str = user
self._value: int = -1
def __str__(self) -> str:
"""
Returns Score class as a string for printing.
Returns:
str: Score class as a string
"""
return self.to_str()
@property
def user(self) -> str:
"""
Getter for score user.
Returns:
str: user
"""
return self._user
@property
def value(self) -> int:
"""
Getter for score value.
Returns:
int: value
"""
return self._value
@value.setter
def value(self, value: int) -> None:
"""
Setter for score value.
Args:
value (int): score value input
"""
self._value = value
def get_str(self) -> str:
"""
Gets score's value as string.
Returns:
str: Score's value
"""
return str(self._value)
def set_value_str(self, value: str) -> None:
"""
Setter for score value from string.
Args:
value (str): int as a string
"""
self._value = int(value)
def to_str(self) -> str:
"""
Returns Score object as a string.
Returns:
str: string of json representation of Score
"""
return f"{self.user}: {self.get_str()}"
class ScoreTime(Score):
"""Class for a time based score. Inherits from Score."""
def __init__(self, user: str) -> None: # pylint: disable=super-init-not-called
"""
Default constructor for ScoreTime class.
Args:
user (str): Score's user
score (float): Score's value
"""
# store time score as seconds.
self._user: str = user
self._score: float = -1.0
@property
def value(self) -> float:
"""
Getter for score value.
Returns:
float: value
"""
return self._score
@value.setter
def value(self, value: float) -> None:
"""
Setter for score value.
Args:
value (float): value
"""
self._score = value
def get_str(self) -> str:
"""
Gets score's value as string. Turns seconds into MM:SS.ms format.
Returns:
str: value in time format.
"""
milliseconds = round((self.value - int(self.value)) * 10)
return time.strftime(f"%-M:%S.{milliseconds}", time.gmtime(self.value))
def set_value_str(self, value: str) -> None:
"""
Setter for score value from a string.
Args:
value (str): string representation of time
"""
if value.find(":"):
self._score = int(value.split(":")[0]) * 60 + float(value.split(":")[1])
else:
self._score = float(value)
+256
View File
@@ -0,0 +1,256 @@
"""
Contains classes and enum for tracking data on submissions.
"""
from enum import Enum
from nextcord import Embed
class SubmissionState(Enum):
"""
Enum for which state a submission is in
"""
CATEGORY = 1
SCORE = 2
PROOF = 3
NAME = 4
SUBMIT = 5
VERIFY = 6
class Submission:
"""
Class for an individual submission. Contains submission information such as
guild id, message id, table, category, username, score and submission state.
"""
def __init__(self, guild_id: int, table: str, username: str) -> None:
"""
Default constructor for Submission. Just need to know guild_id, table, and username.
Score and category are defaulted at empty, message id is 0, and submission state
is SubmissionState.CATEGORY.
"""
self._category: str = ""
self._guild_id: int = guild_id
self._message_id: int = 0
self._score: str = ""
self._submission_state: SubmissionState = SubmissionState.CATEGORY
self._table: str = table
self._username: str = username
@property
def category(self) -> str:
"""
Getter for Submission's Category name.
Returns:
str: Category name.
"""
return self._category
@category.setter
def category(self, category: str) -> None:
"""
Setter for Submission's Category name.
Args:
category (str): Category name
"""
self._category = category
@property
def guild_id(self) -> int:
"""
Getter for guild id Submission is happening in. Will not change.
Returns:
int: guild id
"""
return self._guild_id
@property
def message_id(self) -> int:
"""
Getter for message id that Submission has a view on.
Returns:
int: message id
"""
return self._message_id
@message_id.setter
def message_id(self, m_id: int) -> None:
"""
Setter for message id that Submission has a view on.
Args:
m_id (int): message id
"""
self._message_id = m_id
@property
def score(self) -> str:
"""
Getter for score.
Returns:
str: score
"""
return self._score
@score.setter
def score(self, score: str) -> None:
"""
Setter for score.
Args:
score (str): score
"""
self._score = score
@property
def submission_state(self) -> SubmissionState:
"""
Getter for state Submission is in.
Returns:
SubmissionState: State the Submission is in
"""
return self._submission_state
@submission_state.setter
def submission_state(self, state: SubmissionState) -> None:
"""
Setter for state Submission is in.
Args:
state (SubmissionState): State to change to
"""
self._submission_state = state
@property
def table(self) -> str:
"""
Getter for table Submission is for.
Returns:
str: table name
"""
return self._table
@table.setter
def table(self, table: str) -> None:
"""
Getter for table Submission is for.
Args:
table (str): table name
"""
self._table = table
@property
def username(self) -> str:
"""
Getter for Submission owner's username.
Returns:
str: Submission owner's username
"""
return self._username
@username.setter
def username(self, username: str) -> None:
"""
Setter for Submission owner's username.
Args:
username (str): Submission owner's username
"""
self._username = username
def get_embed(self) -> Embed:
"""Creates an embed based off of the submission state and fields filled out."""
state: SubmissionState = self.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=self.username, inline=False)
embed.add_field(name="Table", value=self.table, inline=False)
if self.category:
embed.add_field(name="Category", value=self.category, inline=False)
if self.score:
embed.add_field(name="Score", value=self.score, inline=False)
return embed
class SubmissionMap:
"""
Tracks all active submission.
"""
def __init__(self) -> None:
"""
Default constructor for SubmissionMap. Created empty map.
"""
self._submission_map: dict = {}
def add_submission(self, user_id: int, submission: Submission) -> None:
"""
Adds new submission to submission map. User id is used as a key, a user should only
have one submission at a time.
Args:
user_id (int): User id of submitter. Unique, used as key.
submission (Submission): Submission object
"""
self._submission_map[user_id] = submission
def get_user_submission(self, user_id: int) -> Submission:
"""
Getter for a user's Submission.
Args:
user_id (int): user id
Returns:
Submission: user's submission
"""
return self._submission_map[user_id]
def has_user(self, user_id: int) -> bool:
"""
Tells if user has an active submission in submission map.
Args:
user_id (int): user id
Returns:
bool: bool indicating if user id is in submission map
"""
return user_id in self._submission_map
def remove_user_submission(self, user_id: int) -> None:
"""
Removes a user's Submission. Use when Submission is complete.
Args:
user_id (int): user id to identify user's Submission
"""
self._submission_map.pop(user_id)
+164
View File
@@ -0,0 +1,164 @@
"""File for Table class."""
import json
from classes.category import Category # pylint: disable=import-error
class Table:
"""Stores a table's information a list of categories."""
def __init__(self, name: str) -> None:
"""
Default constructor for Table class.
Creates object and fills out class variables with defaults.
Args:
name (str): Table's name
"""
self._name: str = name
self._message_id: int = 0
self._categories_map: dict = {}
self._size = 3
def __str__(self) -> str:
"""
Returns Table class as a string for printing.
Returns:
str: Table class as a string
"""
return self.to_str()
@classmethod
def from_dict(cls, table_name: str, data: dict):
"""
Creates a Table class from the passed data.
Args:
table_name (str): Table name
data (dict): Rest of Table data in dictionary format
Returns:
Table: Populated Table object
"""
table = cls(table_name)
table.message_id = data["message_id"]
table.size = data["table_size"]
for cat_name, cat in data["categories"].items():
category = Category.from_dict(cat_name, cat)
table.add_category(category)
return table
@property
def categories(self) -> "list[Category]":
"""
Getter for Categories list.
Returns:
list[Category]: List of Categories in this Table
"""
return self._categories_map.values()
@property
def message_id(self) -> int:
"""
Getter for message id
Returns:
int: message id
"""
return self._message_id
@message_id.setter
def message_id(self, m_id: int) -> None:
"""
Setter for message id.
Args:
m_id (int): message id
"""
self._message_id = m_id
@property
def name(self) -> str:
"""
Getter for name.
Returns:
str: name
"""
return self._name
@property
def size(self) -> int:
"""
Getter for size of table.
Returns:
int: Size of table
"""
return self._size
@size.setter
def size(self, size: int) -> None:
"""
Setter for size of table.
Args:
size (int): New size of table
"""
self._size = size
def add_category(self, category: Category) -> None:
"""
Adds a Category to categories map. Shouldn't exist already.
Args:
category (Category): New Category to add
"""
if category.name not in self._categories_map:
self._categories_map[category.name] = category
def get_category(self, category_name: str) -> Category:
"""
Getter for specific category. Returns None if not found.
Args:
category_name (str): name of category to return
Returns:
Category: Category corresponding to name. None if not found.
"""
if category_name in self._categories_map:
return self._categories_map[category_name]
return None
def to_dict(self) -> dict:
"""
Saves Table as a python dictionary.
Does not include table name. It should be the key of above data structure.
Returns:
dict: Table class in dictionary format
"""
data = {}
data["message_id"] = self.message_id
data["table_size"] = self.size
data["categories"] = {}
for category in self.categories:
data["categories"][category.name] = category.to_dict()
return data
def to_str(self) -> str:
"""
Returns Table object as a string.
Returns:
str: string of json representation of Table
"""
return json.dumps(self.to_dict(), indent=4)
+4 -2
View File
@@ -6,7 +6,6 @@ from nextcord import Embed
from nextcord.ext import commands from nextcord.ext import commands
from highscores import highscores_data # pylint: disable=import-error 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"): class DeleteScores(commands.Cog, name="Delete Scores"):
@@ -30,7 +29,10 @@ class DeleteScores(commands.Cog, name="Delete Scores"):
# only allow AlwaysCompiling to use. # only allow AlwaysCompiling to use.
# If you are a developer and want to use command, can add name to list # If you are a developer and want to use command, can add name to list
if ctx.author.id == 206602713511886849: if ctx.author.id == 206602713511886849:
highscores_data.reset_guild_data(ctx.guild.id) for table in highscores_data.get_guild(ctx.guild.id).tables:
for category in table.categories:
category.clear()
highscores_data.save_guild_data(highscores_data.get_guild(ctx.guild.id))
# This function will be called when this extension is loaded. # This function will be called when this extension is loaded.
+5 -2
View File
@@ -17,7 +17,10 @@ class GuildListener(commands.Cog, name="Guild Listener"):
@commands.Cog.listener() @commands.Cog.listener()
async def on_guild_join(self, guild: nextcord.Guild): async def on_guild_join(self, guild: nextcord.Guild):
"""Listener for Guild Join. Creates skeleton for new guild joined and saves it.""" """Listener for Guild Join. Creates skeleton for new guild joined and saves it."""
highscores_data.add_new_server(guild.id) highscores_data.add_guild(guild.id)
# This add config will be removed eventually. Config adding will have to be controlled by commands.
highscores_data.add_configuration(guild.id, "runescape")
highscores_data.save_guild_data(highscores_data.get_guild(guild.id))
welcome_message: str = "Hello, I keep track of Highscores for you!" welcome_message: str = "Hello, I keep track of Highscores for you!"
welcome_message += " Currently only supporting RuneScape boss highscores," welcome_message += " Currently only supporting RuneScape boss highscores,"
@@ -30,7 +33,7 @@ class GuildListener(commands.Cog, name="Guild Listener"):
async def on_guild_remove(self, guild: nextcord.Guild): async def on_guild_remove(self, guild: nextcord.Guild):
"""Listener for Guild Remove. Removes data from highscores_data.""" """Listener for Guild Remove. Removes data from highscores_data."""
print(f"Removing data for guild {guild.name} (id {guild.id}).") print(f"Removing data for guild {guild.name} (id {guild.id}).")
highscores_data.remove_guild(guild.id, guild.name) highscores_data.remove_guild(guild.id)
# This function will be called when this extension is loaded. # This function will be called when this extension is loaded.
+31 -16
View File
@@ -2,15 +2,15 @@
Defines cog for on message listener. Defines cog for on message listener.
""" """
from datetime import date
import random
import re import re
from nextcord.ext import commands from nextcord.ext import commands
import nextcord import nextcord
from cogs.submission.submission_views import SubmissionState # pylint: disable=import-error from classes.submission import SubmissionState # pylint: disable=import-error
from cogs.submission.submission_views import get_submission_embed # pylint: disable=import-error from highscores import highscores_data, submission_objects # 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"): class SubmissionListener(commands.Cog, name="Message Listener"):
@@ -22,10 +22,23 @@ class SubmissionListener(commands.Cog, name="Message Listener"):
@commands.Cog.listener() @commands.Cog.listener()
async def on_message(self, message: nextcord.Message): async def on_message(self, message: nextcord.Message):
"""Listener for message creation. Adds score and attachments to submission.""" """Listener for message creation. Adds score and attachments to submission."""
# don't want to process any messages from bot.
if message.author.id == self.bot.user.id:
return
guild_id = message.guild.id guild_id = message.guild.id
if message.author.id in submission_objects:
message_id = submission_objects[message.author.id]["message_id"] # troll addition for friends birthday
submission_channel_id = highscores_data.get_guild_submission_channel(guild_id) if guild_id == 239758371358638080 and date.today() == date(2022, 7, 31):
# 5% chance to send the message
chance = random.randint(1, 20)
if chance == 1:
await message.channel.send("Happy Birthday Chris <@642330132958281750>")
if submission_objects.has_user(message.author.id):
submission = submission_objects.get_user_submission(message.author.id)
message_id = submission.message_id
submission_channel_id = highscores_data.get_guild(guild_id).submission_channel
submission_message: nextcord.Message = ( submission_message: nextcord.Message = (
await self.bot.get_guild(guild_id) await self.bot.get_guild(guild_id)
.get_channel(submission_channel_id) .get_channel(submission_channel_id)
@@ -34,12 +47,15 @@ class SubmissionListener(commands.Cog, name="Message Listener"):
# need check if correct user and correct channel # need check if correct user and correct channel
if message.channel.id == submission_channel_id: if message.channel.id == submission_channel_id:
state = submission_objects[message.author.id]["submission_state"] state = submission.submission_state
if state == SubmissionState.SCORE and message.content: if state == SubmissionState.SCORE and message.content:
# check with regex if score matches correctly # check with regex if score matches correctly
is_time_record = highscores_data.get_config_time_record( is_time_record = (
submission_objects[message.author.id]["category"] highscores_data.get_guild(guild_id)
.get_table(submission.table)
.get_category(submission.category)
.time_record
) )
time_regex = re.search( time_regex = re.search(
@@ -71,9 +87,8 @@ class SubmissionListener(commands.Cog, name="Message Listener"):
elif re.search("^[0]?[0-9]:[0-9]{2}(\\.[0-9])?$", score): elif re.search("^[0]?[0-9]:[0-9]{2}(\\.[0-9])?$", score):
# if there is a minute 10ths place 0, remove # if there is a minute 10ths place 0, remove
score = score.lstrip("0") score = score.lstrip("0")
submission_objects[message.author.id]["score"] = score submission.score = score
embed = get_submission_embed(message.author.id) embed = submission.get_embed()
await submission_message.edit( await submission_message.edit(
embed=embed, embed=embed,
) )
@@ -82,10 +97,10 @@ class SubmissionListener(commands.Cog, name="Message Listener"):
files=[await attch.to_file() for attch in message.attachments], files=[await attch.to_file() for attch in message.attachments],
) )
elif state == SubmissionState.NAME and message.content: elif state == SubmissionState.NAME and message.content:
submission_objects[message.author.id]["username"] = message.content[ submission.username = message.content[
: highscores_data.get_guild_username_length(guild_id) : highscores_data.get_guild(guild_id).username_length
] ]
embed = get_submission_embed(message.author.id) embed = submission.get_embed()
await submission_message.edit( await submission_message.edit(
embed=embed, embed=embed,
) )
+15 -5
View File
@@ -27,18 +27,28 @@ class PostHighscores(commands.Cog, name="Post Highscores"):
?post-scores ?post-scores
``` ```
""" """
highscore_channel_id = highscores_data.get_guild_highscores_channel(ctx.guild.id) guild = highscores_data.get_guild(ctx.guild.id)
print(f"Printing out highscores information in channel {highscore_channel_id}") print(f"Printing out highscores information in channel {guild.highscore_channel}")
channel = ctx.guild.get_channel(highscore_channel_id) channel = ctx.guild.get_channel(guild.highscore_channel)
error_response = "Registered Highscores channel does not exist or was never registered. " error_response = "Registered Highscores channel does not exist or was never registered. "
error_response += 'Register with "?register" command.' error_response += 'Register with "?register" command.'
assert channel is not None, await ctx.send(error_response) assert channel is not None, await ctx.send(error_response)
for table in highscores_data.get_table_names(ctx.guild.id): if len(highscores_data.get_guild(ctx.guild.id).tables) < 1:
message: nextcord.Message = await send_highscore_message(channel, table, ctx.guild.id) await channel.send(
"No tables have been created for this guild. Please create some tables."
)
return
for table in highscores_data.get_guild(ctx.guild.id).tables:
message: nextcord.Message = await send_highscore_message(channel, guild, table)
await message.edit(view=SubmissionCreateButton(self.bot)) await message.edit(view=SubmissionCreateButton(self.bot))
# have to save data here in case message id was changed. rather save here after all
# messages have been sent.
highscores_data.save_guild_data(guild)
# This function will be called when this extension is loaded. # This function will be called when this extension is loaded.
# It is necessary to add these functions to the bot. # It is necessary to add these functions to the bot.
+1 -1
View File
@@ -16,7 +16,7 @@ class BotPresence(commands.Cog, name="Bot Presence"):
self.bot = bot self.bot = bot
@commands.Cog.listener() @commands.Cog.listener()
async def on_guild_join(self): async def on_guild_join(self, guild: nextcord.Guild): # pylint: disable=unused-argument
"""Listener for Guild Join. Updated presence on guild join.""" """Listener for Guild Join. Updated presence on guild join."""
await self.change_presence() await self.change_presence()
+102 -46
View File
@@ -2,63 +2,119 @@
Bot command for registering various channels to the bot. Bot command for registering various channels to the bot.
""" """
from nextcord import Embed from typing import Optional
from nextcord import Embed, Interaction, Permissions, SlashOption
import nextcord
from nextcord.ext import commands from nextcord.ext import commands
from highscores import highscores_data # pylint: disable=import-error from highscores import highscores_data # pylint: disable=import-error
class RegisterVerificationChannel(commands.Cog, name="Register"): class Register(commands.Cog, name="Register"):
"""Bot command for registering various channels to the bot.""" """
Class holds various register commands.
def __init__(self, bot: commands.Bot): Args:
self.bot = bot commands.Cog: Parent class
name (str, optional): Name of Cog. Defaults to "Register".
"""
@commands.command(name="register") def __init__(self) -> None:
@commands.has_permissions(administrator=True) """
async def register_highscores(self, ctx: commands.Context, registration_type: str): Default constructor for Register class. Does nothing.
"""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": @nextcord.slash_command(default_member_permissions=Permissions(administrator=True))
await ctx.send(f"Registered <#{channel_id}> as channel to post verifications in.") async def register(self):
highscores_data.set_guild_verification_channel(ctx.guild.id, channel_id) """
elif registration_type == "highscore": Parent slash command, never called.
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": @register.subcommand(description="Registers the channel for perminent highscores messages.")
await ctx.send(f"Registered <#{channel_id}> as channel to post submissions in.") async def highscore(
highscores_data.set_guild_submission_channel(ctx.guild.id, channel_id) self,
else: interaction: nextcord.Interaction,
embed = Embed( channel: nextcord.abc.GuildChannel = SlashOption(
title="Register command help", description="How to use the register command." description="Channel to register",
) required=False,
embed.add_field( channel_types=[nextcord.ChannelType.text],
name="?register verify", value="Use in channel you want to verify submissions in." default=None,
) ),
embed.add_field( ) -> None:
name="?register highscore", """
value="Use in channel you want to show highscore messages in.", Command function to register the highscore printing channel.
)
embed.add_field( Args:
name="?register submission", interaction (nextcord.Interaction): Interaction that invoked the command
value="Use in channel you want submission messages to be send it.", channel (nextcord.abc.GuildChannel, optional): Channel to register
) Is a SlashOption. Limited to text channels, Defaults to None.
embed.add_field(name="?register help", value="Use to show this message.") """
await ctx.reply(embed=embed) if not channel:
channel = interaction.channel
channel_id = channel.id
guild = highscores_data.get_guild(interaction.guild_id)
await interaction.send(f"Registered <#{channel_id}>.", ephemeral=True)
guild.highscore_channel = channel_id
highscores_data.save_guild_data(guild)
@register.subcommand(description="Registers the channel for submission messages.")
async def submission(
self,
interaction: nextcord.Interaction,
channel: nextcord.abc.GuildChannel = SlashOption(
description="Channel to register",
required=False,
channel_types=[nextcord.ChannelType.text],
default=None,
),
) -> None:
"""
Command function to register the submission message channel.
Args:
interaction (nextcord.Interaction): Interaction that invoked the command
channel (nextcord.abc.GuildChannel, optional): Channel to register
Is a SlashOption. Limited to text channels, Defaults to None.
"""
if not channel:
channel = interaction.channel
channel_id = channel.id
guild = highscores_data.get_guild(interaction.guild_id)
await interaction.send(f"Registered <#{channel_id}>.", ephemeral=True)
guild.submission_channel = channel_id
highscores_data.save_guild_data(guild)
@register.subcommand(description="Registers the channel for verification messages.")
async def verify(
self,
interaction: nextcord.Interaction,
channel: nextcord.abc.GuildChannel = SlashOption(
description="Channel to register",
required=False,
channel_types=[nextcord.ChannelType.text],
default=None,
),
) -> None:
"""
Command function to register the verification message channel.
Args:
interaction (nextcord.Interaction): Interaction that invoked the command
channel (nextcord.abc.GuildChannel, optional): Channel to register
Is a SlashOption. Limited to text channels, Defaults to None.
"""
if not channel:
channel = interaction.channel
channel_id = channel.id
guild = highscores_data.get_guild(interaction.guild_id)
await interaction.send(f"Registered <#{channel_id}>.", ephemeral=True)
guild.verification_channel = channel_id
highscores_data.save_guild_data(guild)
# This function will be called when this extension is loaded. # This function will be called when this extension is loaded.
# It is necessary to add these functions to the bot. # It is necessary to add these functions to the bot.
def setup(bot: commands.Bot): def setup(bot: commands.Bot) -> None:
"""Adds function to bot""" """Adds function to bot"""
bot.add_cog(RegisterVerificationChannel(bot)) bot.add_cog(Register())
-53
View File
@@ -1,53 +0,0 @@
"""
Bot command to submit a score
"""
from nextcord.ext import commands
from highscores import highscores_data # pylint: disable=import-error
from .verification_view import VerificationView
class Score(commands.Cog, name="Score"):
"""Submits a score."""
def __init__(self, bot: commands.Bot):
self.bot = bot
@commands.Cog.listener()
async def on_ready(self):
"""Called when the cog is loaded"""
self.bot.add_view(VerificationView())
@commands.command(name="score")
async def score(self, ctx: commands.Context, boss_name: str, category: str, score: str):
"""A command which calls a function to submit the score to highscores.
Gathers required information from command and passes on.
Usage:
```
?score "Boss Name" "Category" "score"
This command still works if you prefer to use it over the ui.
```
"""
guild_data = highscores_data[str(ctx.guild.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 += "Contact server admins."
assert channel is not None, await ctx.send(error_response)
verification_string = f"{ctx.author.display_name}:{boss_name}:{category}:{score}"
await channel.send(
content=verification_string,
files=[await attch.to_file() for attch in ctx.message.attachments],
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(Score(bot))
-40
View File
@@ -1,40 +0,0 @@
"""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="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
"""Button for approving score submission."""
content = interaction.message.content.split(":")
user = content[0]
boss_name = content[1]
category = content[2]
score = content[3]
await submit_score(interaction, user, boss_name, category, score)
await interaction.message.delete()
await interaction.channel.send(
f"Approved: {boss_name} {category} {user} {score}",
files=[await attch.to_file() for attch in interaction.message.attachments],
)
@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
"""Button for denying score submission."""
await interaction.message.delete()
+54 -90
View File
@@ -1,63 +1,25 @@
"""Views used for submission process.""" """Views used for submission process."""
from typing import Optional from typing import Optional
from enum import Enum
import nextcord import nextcord
from nextcord import Embed
from nextcord.ext import commands from nextcord.ext import commands
from highscores import highscores_data # pylint: disable=import-error from classes.submission import Submission, SubmissionState # pylint: disable=import-error
from highscores import highscores_message_map # pylint: disable=import-error from highscores import ( # pylint: disable=import-error
from highscores import submission_objects # pylint: disable=import-error highscores_data,
highscores_message_map,
submission_objects,
)
from .verification_view import VerificationView 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]": def category_select_options(guild_id: int, boss_name: str) -> "list[nextcord.SelectOption]":
"""Returns list of categories for a given boss.""" """Returns list of categories for a given boss."""
options: "list[nextcord.SelectOption]" = [] options: "list[nextcord.SelectOption]" = []
category_list = highscores_data.get_table_categories(guild_id, boss_name) category_list = highscores_data.get_guild(guild_id).get_table(boss_name).categories
for category in category_list: for category in category_list:
options.append(nextcord.SelectOption(label=category)) options.append(nextcord.SelectOption(label=category.name))
return options return options
@@ -79,8 +41,9 @@ class SubmissionDropdown(nextcord.ui.Select):
self._bot = bot self._bot = bot
async def callback(self, interaction: nextcord.Interaction): async def callback(self, interaction: nextcord.Interaction):
submission_objects[interaction.user.id]["category"] = self.values[0] submission = submission_objects.get_user_submission(interaction.user.id)
embed = get_submission_embed(interaction.user.id) submission.category = self.values[0]
embed = submission.get_embed()
await interaction.message.edit( await interaction.message.edit(
embed=embed, embed=embed,
) )
@@ -94,10 +57,11 @@ class BackButton(nextcord.ui.Button):
self._bot = bot self._bot = bot
async def callback(self, interaction: nextcord.Interaction): async def callback(self, interaction: nextcord.Interaction):
state: SubmissionState = submission_objects[interaction.user.id]["submission_state"] submission = submission_objects.get_user_submission(interaction.user.id)
state: SubmissionState = submission.submission_state
state = SubmissionState(state.value - 1) state = SubmissionState(state.value - 1)
submission_objects[interaction.user.id]["submission_state"] = state submission.submission_state = state
embed = get_submission_embed(interaction.user.id) embed = submission.get_embed()
await interaction.edit(embed=embed, view=SubmissionView(self._bot, interaction.user.id)) await interaction.edit(embed=embed, view=SubmissionView(self._bot, interaction.user.id))
@@ -108,7 +72,7 @@ class CancelButton(nextcord.ui.Button):
super().__init__(label="Cancel", style=nextcord.ButtonStyle.red, custom_id="cancel") super().__init__(label="Cancel", style=nextcord.ButtonStyle.red, custom_id="cancel")
async def callback(self, interaction: nextcord.Interaction): async def callback(self, interaction: nextcord.Interaction):
submission_objects.pop(interaction.user.id) submission_objects.remove_user_submission(interaction.user.id)
await interaction.message.delete() await interaction.message.delete()
@@ -121,22 +85,18 @@ class NextButton(nextcord.ui.Button):
async def callback(self, interaction: nextcord.Interaction): async def callback(self, interaction: nextcord.Interaction):
# check if fields have been filled out for each state # check if fields have been filled out for each state
state: SubmissionState = submission_objects[interaction.user.id]["submission_state"] submission = submission_objects.get_user_submission(interaction.user.id)
if ( state: SubmissionState = submission.submission_state
state == SubmissionState.CATEGORY if state == SubmissionState.CATEGORY and not submission.category:
and not submission_objects[interaction.user.id]["category"]
):
await interaction.send("Please choose a category.", ephemeral=True) await interaction.send("Please choose a category.", ephemeral=True)
elif ( elif state == SubmissionState.SCORE and not submission.score:
state == SubmissionState.SCORE and not submission_objects[interaction.user.id]["score"]
):
await interaction.send("Please send a score.", ephemeral=True) await interaction.send("Please send a score.", ephemeral=True)
elif state == SubmissionState.PROOF and not len(interaction.message.attachments) > 0: elif state == SubmissionState.PROOF and not len(interaction.message.attachments) > 0:
await interaction.send("Please attach picture for proof.", ephemeral=True) await interaction.send("Please attach picture for proof.", ephemeral=True)
else: else:
state = SubmissionState(state.value + 1) state = SubmissionState(state.value + 1)
submission_objects[interaction.user.id]["submission_state"] = state submission.submission_state = state
embed = get_submission_embed(interaction.user.id) embed = submission.get_embed()
await interaction.edit(embed=embed, view=SubmissionView(self._bot, interaction.user.id)) await interaction.edit(embed=embed, view=SubmissionView(self._bot, interaction.user.id))
@@ -148,18 +108,19 @@ class SubmitButton(nextcord.ui.Button):
self._bot = bot self._bot = bot
async def callback(self, interaction: nextcord.Interaction): async def callback(self, interaction: nextcord.Interaction):
verification_channel_id = highscores_data.get_guild_verification_channel( verification_channel_id = highscores_data.get_guild(
interaction.guild_id interaction.guild_id
) ).verification_channel
channel = interaction.guild.get_channel(verification_channel_id) channel = interaction.guild.get_channel(verification_channel_id)
submission = submission_objects.get_user_submission(interaction.user.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." Contact server admins."
assert channel is not None, await channel.send(error_response) assert channel is not None, await channel.send(error_response)
submission_objects[interaction.user.id]["submission_state"] = SubmissionState.VERIFY submission.submission_state = SubmissionState.VERIFY
embed = get_submission_embed(interaction.user.id) embed = submission.get_embed()
await channel.send( await channel.send(
files=[await attch.to_file() for attch in interaction.message.attachments], files=[await attch.to_file() for attch in interaction.message.attachments],
@@ -168,7 +129,7 @@ class SubmitButton(nextcord.ui.Button):
content=f"Submission from {interaction.user.display_name}", content=f"Submission from {interaction.user.display_name}",
) )
await interaction.message.edit(content=f"<@{interaction.user.id}> Submitted!", view=None) await interaction.message.edit(content=f"<@{interaction.user.id}> Submitted!", view=None)
submission_objects.pop(interaction.user.id) submission_objects.remove_user_submission(interaction.user.id)
############ Submission Views ############ ############ Submission Views ############
@@ -189,31 +150,25 @@ class SubmissionCreateButton(nextcord.ui.View):
): # pylint: disable=unused-argument ): # pylint: disable=unused-argument
"""Button for score submission.""" """Button for score submission."""
# Don't allow a user to start a new submission if one already exists # Don't allow a user to start a new submission if one already exists
if interaction.user.id in submission_objects: if submission_objects.has_user(interaction.user.id):
await interaction.send("Please finish in progress submission first.", ephemeral=True) await interaction.send("Please finish in progress submission first.", ephemeral=True)
return return
boss_name = highscores_message_map[interaction.guild.id][interaction.message.id] table = highscores_message_map[interaction.guild.id][interaction.message.id]
channel = interaction.guild.get_channel( channel = interaction.guild.get_channel(
highscores_data.get_guild_submission_channel(interaction.guild_id) highscores_data.get_guild(interaction.guild_id).submission_channel
) )
# a user should only have 1 submission active at once. # a user should only have 1 submission active at once.
# submitting with dummy message_id until message created # split username on pipe then limit length.
# split username on pipe. username: str = interaction.user.display_name.split("|")[0][
submission_objects[interaction.user.id] = { : highscores_data.get_guild(interaction.guild_id).username_length
"message_id": 0, ]
"guild_id": interaction.guild_id, submission: Submission = Submission(interaction.guild_id, table, username)
"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_objects.add_submission(interaction.user.id, submission)
embed = submission.get_embed()
submission_message = await channel.send( submission_message = await channel.send(
f"<@{interaction.user.id}>", f"<@{interaction.user.id}>",
@@ -225,7 +180,7 @@ class SubmissionCreateButton(nextcord.ui.View):
) )
# update the message_id once its created # update the message_id once its created
submission_objects[interaction.user.id]["message_id"] = submission_message.id submission.message_id = submission_message.id
class SubmissionView(nextcord.ui.View): class SubmissionView(nextcord.ui.View):
@@ -236,14 +191,14 @@ class SubmissionView(nextcord.ui.View):
bot: commands.Bot, bot: commands.Bot,
submission_user: int, submission_user: int,
*, *,
timeout: Optional[float] = 180, timeout: Optional[float] = 300,
): ):
super().__init__(timeout=timeout) super().__init__(timeout=timeout)
self._submission_user = submission_user self._submission_user = submission_user
self._bot = bot self._bot = bot
self._state = submission_objects[self._submission_user]["submission_state"] self._state = submission_objects.get_user_submission(self._submission_user).submission_state
self._boss_name = submission_objects[self._submission_user]["boss_name"] self._boss_name = submission_objects.get_user_submission(self._submission_user).table
self._guild_id = submission_objects[self._submission_user]["guild_id"] self._guild_id = submission_objects.get_user_submission(self._submission_user).guild_id
# add items depending on given state # add items depending on given state
if self._state is SubmissionState.CATEGORY: if self._state is SubmissionState.CATEGORY:
@@ -264,4 +219,13 @@ class SubmissionView(nextcord.ui.View):
self.add_item(SubmitButton(self._bot)) self.add_item(SubmitButton(self._bot))
async def interaction_check(self, interaction: nextcord.Interaction) -> bool: async def interaction_check(self, interaction: nextcord.Interaction) -> bool:
return self._submission_user == interaction.user.id check = self._submission_user == interaction.user.id
if not check:
await interaction.send("This is not your submission.", ephemeral=True)
return check
async def on_timeout(self) -> None:
# remove user from submission objects after time out. Allows user to start new submission.
submission_objects.remove_user_submission(self._submission_user)
+22 -3
View File
@@ -1,6 +1,9 @@
"""View for verification buttons""" """View for verification buttons"""
import nextcord import nextcord
from classes.score import Score, ScoreTime # pylint: disable=import-error
from highscores import highscores_data # pylint: disable=import-error
from utilities.utils import submit_score # pylint: disable=import-error from utilities.utils import submit_score # pylint: disable=import-error
@@ -29,8 +32,8 @@ class VerificationView(nextcord.ui.View):
content = interaction.message.embeds[0].to_dict() content = interaction.message.embeds[0].to_dict()
for field in content["fields"]: for field in content["fields"]:
if field["name"] == "Boss": if field["name"] == "Table":
boss_name = field["value"] table = field["value"]
elif field["name"] == "Category": elif field["name"] == "Category":
category = field["value"] category = field["value"]
elif field["name"] == "Score": elif field["name"] == "Score":
@@ -39,7 +42,23 @@ class VerificationView(nextcord.ui.View):
user = field["value"] user = field["value"]
try: try:
await submit_score(interaction, user, boss_name, category, score) submission_guild = highscores_data.get_guild(interaction.guild_id)
submission_table = submission_guild.get_table(table)
submission_category = submission_table.get_category(category)
if submission_category.time_record:
submission_score: ScoreTime = ScoreTime(user)
submission_score.set_value_str(score)
else:
submission_score: Score = Score(user)
submission_score.set_value_str(score)
await submit_score(
interaction,
submission_guild,
submission_table,
submission_category,
submission_score,
)
await interaction.message.edit(f"Approved by <@{interaction.user.id}>.", view=None) await interaction.message.edit(f"Approved by <@{interaction.user.id}>.", view=None)
except UnboundLocalError: except UnboundLocalError:
await interaction.send("Instruct user to submit with all fields.") await interaction.send("Instruct user to submit with all fields.")
@@ -1,8 +1,8 @@
{ {
"tables": { "tables": {
"The Ambassador": [ "The Ambassador": [
"Kill Count", "Solo Kill Count",
"Kill Time", "Solo Kill Time",
"Group Kill Count", "Group Kill Count",
"Group Kill Time", "Group Kill Time",
"Spooned Log" "Spooned Log"
@@ -21,8 +21,8 @@
"Spooned Log" "Spooned Log"
], ],
"Astellarn": [ "Astellarn": [
"Kill Count", "Solo Kill Count",
"Kill Time", "Solo Kill Time",
"Group Kill Count", "Group Kill Count",
"Group Kill Time", "Group Kill Time",
"Spooned Log" "Spooned Log"
@@ -42,8 +42,8 @@
"Spooned Log" "Spooned Log"
], ],
"Black Stone Dragon": [ "Black Stone Dragon": [
"Kill Count", "Solo Kill Count",
"Kill Time", "Solo Kill Time",
"Group Kill Count", "Group Kill Count",
"Group Kill Time", "Group Kill Time",
"Spooned Log" "Spooned Log"
@@ -65,8 +65,8 @@
"Spooned Log" "Spooned Log"
], ],
"Crassian Leviathan": [ "Crassian Leviathan": [
"Kill Count", "Solo Kill Count",
"Kill Time", "Solo Kill Time",
"Group Kill Count", "Group Kill Count",
"Group Kill Time", "Group Kill Time",
"Spooned Log" "Spooned Log"
@@ -160,8 +160,8 @@
"Spooned Log" "Spooned Log"
], ],
"Masuta the Ascended": [ "Masuta the Ascended": [
"Kill Count", "Solo Kill Count",
"Kill Time", "Solo Kill Time",
"Group Kill Count", "Group Kill Count",
"Group Kill Time", "Group Kill Time",
"Spooned Log" "Spooned Log"
@@ -193,15 +193,15 @@
"Spooned Log" "Spooned Log"
], ],
"The Sanctum Guardian": [ "The Sanctum Guardian": [
"Kill Count", "Solo Kill Count",
"Kill Time", "Solo Kill Time",
"Group Kill Count", "Group Kill Count",
"Group Kill Time", "Group Kill Time",
"Spooned Log" "Spooned Log"
], ],
"Seiryu the Azure Serpent": [ "Seiryu the Azure Serpent": [
"Kill Count", "Solo Kill Count",
"Kill Time", "Solo Kill Time",
"Group Kill Count", "Group Kill Count",
"Group Kill Time", "Group Kill Time",
"Spooned Log" "Spooned Log"
@@ -331,5 +331,5 @@
"is_time_record": false "is_time_record": false
} }
}, },
"highscore_size": 3 "table_size": 3
} }
+7 -7
View File
@@ -10,7 +10,8 @@ import nextcord
from nextcord.ext import commands from nextcord.ext import commands
import config import config
from utilities.highscores_data import HighscoresData from classes.highscores_data import HighscoresData
from classes.submission import SubmissionMap
logger = logging.getLogger("nextcord") logger = logging.getLogger("nextcord")
logger.setLevel(logging.DEBUG) logger.setLevel(logging.DEBUG)
@@ -22,13 +23,12 @@ logger.addHandler(handler)
highscores_data: HighscoresData = HighscoresData() highscores_data: HighscoresData = HighscoresData()
highscores_message_map = {} highscores_message_map = {}
for guild in highscores_data.get_guilds(): for guild in highscores_data.guilds:
highscores_message_map[guild] = {} highscores_message_map[guild.guild_id] = {}
for table in highscores_data.get_table_names(guild): for table in guild.tables:
message_id = highscores_data.get_table_message_id(guild, table) highscores_message_map[guild.guild_id][table.message_id] = table.name
highscores_message_map[guild][message_id] = table
submission_objects: dict = {} submission_objects: SubmissionMap = SubmissionMap()
def main(): def main():
-304
View File
@@ -1,304 +0,0 @@
"""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:
scores_list = {}
boss_categories[category] = scores_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_list = [score, score_seconds]
sort_index = 1
else:
score_list = [int(score)]
sort_index = 0
# Will not ensure new score is better than old one. Allows for correcting mistakes.
scores[user] = score_list
scores = dict(sorted(scores.items(), key=lambda x: x[1][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))
+59 -47
View File
@@ -3,42 +3,46 @@ Contains various utlity functions for highscores bot
""" """
import nextcord import nextcord
from highscores import highscores_data # pylint: disable=import-error from highscores import highscores_data, highscores_message_map # pylint: disable=import-error
from highscores import highscores_message_map # pylint: disable=import-error from classes.score import Score # pylint: disable=import-error
from classes.guild import Guild # pylint: disable=import-error
from classes.category import Category # pylint: disable=import-error
from classes.table import Table # pylint: disable=import-error
def format_highscore_message(boss_name: str, guild_id: int): def format_highscore_message(guild: Guild, table: Table) -> str:
""" """
returns a formatted string for a boss's highscore Creates a formatted string for a boss's highscore discord message.
@param boss: the dictionary object for the boss This formatted string is in discord's code block to ensure monospace text.
@param guild_id: the guild id the message is for Loops through each category to build the message one place at a time.
@return the formatted string
Args:
guild (Guild): Guild object that is posting the message.
table (Table): Table object that contains the contents of the message.
Returns:
str: Formatted string for discord message
""" """
ret_string = f"**{boss_name}**\n```" ret_string = f"**{table.name}**\n```"
# Gather all categories and add to string # Gather all categories and add to string
for category_name in highscores_data.get_table_categories(guild_id, boss_name): for category in table.categories:
ret_string += f"{category_name}".ljust(26, " ") ret_string += f"{category.name}".ljust(26, " ")
ret_string += "\n" ret_string += "\n"
highscore_size = highscores_data.get_config_highscore_size()
# list rankings in a single line. Start with first place for each category and then continue # list rankings in a single line. Start with first place for each category and then continue
for i in range(highscore_size): for i in range(table.size):
for category_name, category_data in highscores_data.get_categories_data( for category in table.categories:
guild_id, boss_name if len(category.scores) > i:
):
if len(category_data) > i:
# pad username to max length. # pad username to max length.
username: str = list(category_data.keys())[i].ljust( # have to convert category.scores into list to make it subscriptable. no idea why.
highscores_data.get_guild_username_length(guild_id), " " username: str = list(category.scores)[i].user.ljust(guild.username_length, " ")
)
# turns category data value into a string. Very janky. score: str = list(category.scores)[i].get_str()
score: str = str(list(category_data.values())[i][0])
# pad score to correct length # pad score to correct length
# MM:SS.ms is 7 characters long # MM:SS.ms is 7 characters long
if highscores_data.get_config_time_record(category_name): if category.time_record:
# if there are single digit minutes, add a space for formatting. # if there are single digit minutes, add a space for formatting.
if score.find(":") and len(score.split(":", maxsplit=1)[0]) < 2: if score.find(":") and len(score.split(":", maxsplit=1)[0]) < 2:
score = " " + score score = " " + score
@@ -54,19 +58,23 @@ def format_highscore_message(boss_name: str, guild_id: int):
async def send_highscore_message( async def send_highscore_message(
channel: nextcord.TextChannel, boss_name: str, guild_id: int channel: nextcord.TextChannel, guild: Guild, table: Table
) -> nextcord.Message: ) -> nextcord.Message:
""" """
Function takes care of checking if a message exists for a boss, then Function takes care of checking if a message exists for a table.
creating and sending/editing the message Creates and sends/edits 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, guild_id)
message_id = highscores_data.get_table_message_id(guild_id, boss_name) Args:
channel (nextcord.TextChannel): Discord channel object where message is sent
guild (Guild): Guild object for Guild that is posting the message
table (Table): Table to post to the message
Returns:
nextcord.Message: Message object that was posted with table contents
"""
highscore_string = format_highscore_message(guild, table)
message_id = table.message_id
try: try:
message: nextcord.Message = await channel.fetch_message(message_id) message: nextcord.Message = await channel.fetch_message(message_id)
await message.edit(content=highscore_string) await message.edit(content=highscore_string)
@@ -74,38 +82,42 @@ async def send_highscore_message(
# message doesn't exist. # message doesn't exist.
message: nextcord.Message = await channel.send(highscore_string) message: nextcord.Message = await channel.send(highscore_string)
message_id = message.id message_id = message.id
highscores_data.set_table_message_id(guild_id, boss_name, message_id) table.message_id = message_id
# save message -> boss_name in message_map # save message -> boss_name in message_map
# get guild id from channel # get guild id from channel
# channel should come from the guild that is requesting this highscores message anyways. # channel should come from the guild that is requesting this highscores message anyways.
# check if guild is in message map already # check if guild is in message map already
if not channel.guild.id in highscores_message_map: if not channel.guild.id in highscores_message_map:
highscores_message_map[channel.guild.id] = {} highscores_message_map[channel.guild.id] = {}
highscores_message_map[channel.guild.id][message_id] = boss_name highscores_message_map[channel.guild.id][message_id] = table.name
return message return message
async def submit_score( async def submit_score(
interaction: nextcord.Interaction, user: str, boss_name: str, category: str, score: str interaction: nextcord.Interaction, guild: Guild, table: Table, category: Category, score: Score
): ) -> None:
""" """
Adds a score to the high scores and sorts. Removes a score if larger than size limit. Adds passed score to table. Then updates table message by calling send_highscore_message.
@param boss: the boss to add score to Ensures that a highscores channel exists.
@param category: the category to add score to
@param user: user who submitted score Args:
@param score: score to add interaction (nextcord.Interaction): Interaction that caused the score submission
guild (Guild): Guild to submit score to
table (Table): Table to submit score to
category (Category): Category to submit score to
score (Score): Score to submit
""" """
highscores_data.add_score(interaction.guild_id, boss_name, category, user, score) category.add_score(score)
highscores_data.save_guild_data(guild)
# edit message # edit message
highscore_channel_id = highscores_data.get_guild_highscores_channel(interaction.guild_id) print(f"Editting message {guild.highscore_channel}")
print(f"Editting message {highscore_channel_id}") channel = interaction.guild.get_channel(guild.highscore_channel)
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."
error_response += 'Register with "?register" command.' error_response += 'Register with "?register" command.'
assert channel is not None, await interaction.send(error_response, ephemeral=True) assert channel is not None, await interaction.send(error_response, ephemeral=True)
await send_highscore_message(channel, boss_name, interaction.guild_id) await send_highscore_message(channel, guild, table)