GoldyBot.utility.guilds.guild

  1import asyncio
  2import json
  3import os
  4from typing import List
  5import nextcord
  6import GoldyBot
  7from . import config
  8
  9MODULE_NAME = "GUILD"
 10
 11GUILD_CONFIG_TEMPLATE_JSON_PATH = GoldyBot.paths.GOLDY_BOT + "/utility/guilds/guild_config_template.json"
 12
 13class Guild():
 14    """Class that represents a discord guild in Goldy Bot."""
 15    def __init__(self, guild:nextcord.Guild):
 16        self.guild = guild
 17        self.database:GoldyBot.database.Database = GoldyBot.cache.main_cache_dict["database"]
 18
 19        self.goldy_config = GoldyBot.config.Config(GoldyBot.files.File(GoldyBot.paths.GOLDY_CONFIG_JSON))
 20
 21        self.allowed_guilds = self.goldy_config.read("allowed_guilds")
 22        self.config_file = self.get_config_file()
 23
 24        # Cache this!
 25        if self.is_allowed:
 26            GoldyBot.cache.main_cache_dict["guilds"][f"{self.code_name}"] = {}
 27            GoldyBot.cache.main_cache_dict["guilds"][f"{self.code_name}"]["object"] = self
 28
 29    async def setup(self):
 30        """Setup's a guild in Goldy Bot with the given nextcord guild object. This will create a config and database collection for the guild."""
 31        if self.is_allowed:
 32            # Generate config folder for guild of there isn't already.
 33            #-----------------------------------
 34            if not self.config_exist:
 35                # If the config is empty, write the guild config template to it.
 36                template = GoldyBot.files.File(GUILD_CONFIG_TEMPLATE_JSON_PATH).read()
 37                template_json_obj = json.loads(template)
 38                template_json_obj["id"] = self.id
 39                template_json_obj["code_name"] = self.code_name
 40                template_json_obj["display_name"] = self.guild.name
 41                self.config_file.write(json.dumps(template_json_obj))
 42
 43            # Create a database collection for the guild if there isn't already.
 44            #--------------------------------------------------------------------
 45            if not self.database == None:
 46                if not await self.database_exist:
 47                    await self.database.create_collection(f"{self.code_name} (server)", {"_id":1, 
 48                    "goldy":"I've created this collection automatically for a guild.", 
 49                    "notice":"Feel free to delete this document."})
 50            else:
 51                GoldyBot.logging.log("warn", f"[{MODULE_NAME}] Skipping database guild collection creation because database is disabled.")
 52
 53            GoldyBot.logging.log(f"We ran setup for the guild '{self.code_name}'.")
 54        else:
 55            GoldyBot.logging.log("warn", f"Setup for '{self.code_name}' did not run because guild is not in goldy bot guild list.")
 56
 57    @property
 58    def id(self):
 59        return self.guild.id
 60
 61    @property
 62    def code_name(self):
 63        try:
 64            return self.allowed_guilds[f"{self.id}"]
 65        except KeyError:
 66            return None
 67
 68    @property
 69    def nextcord_guild_object(self) -> nextcord.Guild:
 70        """Returns back the nextcord guild class you entered before."""
 71        return self.guild
 72
 73    @property
 74    def config(self) -> config.GuildConfig:
 75        """Returns guild's config class."""
 76        #TODO: If the config does not exist run guild setup.
 77        if self.config_exist:
 78            return config.GuildConfig(GoldyBot.config.Config(GoldyBot.files.File(f"{GoldyBot.paths.CONFIG}/{self.code_name}/config.json")))
 79
 80    @property
 81    def is_allowed(self) -> bool:
 82        """Commands Goldy Bot to check whether the guild is allowed to be active."""
 83        try:
 84            self.allowed_guilds[f"{self.id}"] # If this fails then guild is not in list.
 85            return True
 86        except KeyError:
 87            return False
 88
 89    @property
 90    def has_config_been_edited(self) -> bool:
 91        """Commands Goldy Bot to check if the config of this guild has actually been edited or not. Returns False if config does not exist."""
 92        if self.config_exist:
 93            if self.config_file.read() == GoldyBot.files.File(GUILD_CONFIG_TEMPLATE_JSON_PATH).read():
 94                return False
 95            else:
 96                return True
 97        else:
 98            return False
 99
100    @property
101    def config_exist(self) -> bool:
102        """Commands Goldy Bot to check if the guild exist in config."""
103        if self.code_name in os.listdir(GoldyBot.paths.CONFIG):
104            if self.config_file.read() in ["", "{}"]:
105                return False
106            return True
107        else:
108            return False
109
110    @property
111    async def database_exist(self) -> bool:
112        """Commands Goldy Bot to check if the guild exist in the database collections."""
113        if self.database_collection_name in await self.database.list_collection_names():
114            return True
115        else:
116            return False
117
118    @property
119    def database_collection_name(self) -> str:
120        return f"{self.code_name} (server)"
121
122    def channels(self) -> List[GoldyBot.objects.channel.Channel]:
123        """Returns all channels in the guild. IDK if this method works well lmao, I haven't done much testing."""
124        channels_list:List[GoldyBot.objects.channel.Channel] = []
125        for nc_channel in self.guild.channels:
126            channels_list.append(GoldyBot.objects.channel.Channel(None, channel_object=nc_channel))
127
128        return channels_list
129
130    def get_config_file(self) -> GoldyBot.files.File:
131        # Create guild config folder.
132        GUILD_CONFIG_FOLDER_PATH = GoldyBot.files.File(GoldyBot.paths.CONFIG + f"/{self.code_name}/").file_path
133
134        # Create guild config file.
135        config_file = GoldyBot.files.File(GUILD_CONFIG_FOLDER_PATH + "config.json")
136
137        return config_file
138
139    async def get_members(self, ctx):
140        """Method to get all the discord guild members."""
141
142        member_list_:List[GoldyBot.Member] = []
143        for member in self.guild.members:
144            member_list_.append(GoldyBot.objects.member.Member(ctx, member_object=member))
145
146        return member_list_
147
148    async def get_channels(self, ctx):
149        """Method to get all the discord guild's channels."""
150
151        channel_list_:List[GoldyBot.Channel] = []
152        for channel in self.guild.channels:
153            channel_list_.append(GoldyBot.objects.channel.Channel(ctx, channel_object=channel))
154
155        return channel_list_