import asyncio import contextlib import datetime import importlib import inspect import logging import pkgutil from pathlib import Path from typing import List, Optional, Type, Union import async_timeout import discord from discord.ext import commands from bot.constants import Channels, Client, Roles, bot from bot.decorators import with_role log = logging.getLogger(__name__) def get_seasons() -> List[str]: """ Returns all the Season objects located in bot/seasons/ """ seasons = [] for module in pkgutil.iter_modules([Path("bot", "seasons")]): if module.ispkg: seasons.append(module.name) return seasons def get_season_class(season_name: str) -> Type["SeasonBase"]: """ Get's the season class of the season module. """ season_lib = importlib.import_module(f"bot.seasons.{season_name}") class_name = season_name.replace("_", " ").title().replace(" ", "") return getattr(season_lib, class_name) def get_season(season_name: str = None, date: datetime.datetime = None) -> "SeasonBase": """ Returns a Season object based on either a string or a date. """ # If either both or neither are set, raise an error. if not bool(season_name) ^ bool(date): raise UserWarning("This function requires either a season or a date in order to run.") seasons = get_seasons() # Use season override if season name not provided if not season_name and Client.season_override: log.debug(f"Season override found: {Client.season_override}") season_name = Client.season_override # If name provided grab the specified class or fallback to evergreen. if season_name: season_name = season_name.lower() if season_name not in seasons: season_name = "evergreen" season_class = get_season_class(season_name) return season_class() # If not, we have to figure out if the date matches any of the seasons. seasons.remove("evergreen") for season_name in seasons: season_class = get_season_class(season_name) # check if date matches before returning an instance if season_class.is_between_dates(date): return season_class() else: evergreen_class = get_season_class("evergreen") return evergreen_class() class SeasonBase: """ Base class for Seasonal classes. """ name: Optional[str] = "evergreen" bot_name: str = "SeasonalBot" start_date: Optional[str] = None end_date: Optional[str] = None colour: Optional[int] = None icon: str = "/logos/logo_full/logo_full.png" bot_icon: Optional[str] = None date_format: str = "%d/%m/%Y" @staticmethod def current_year() -> int: """ Returns the current year. """ return datetime.date.today().year @classmethod def start(cls) -> datetime.datetime: """ Returns the start date using current year and start_date attribute. If no start_date was defined, returns the minimum datetime to ensure it's always below checked dates. """ if not cls.start_date: return datetime.datetime.min return datetime.datetime.strptime(f"{cls.start_date}/{cls.current_year()}", cls.date_format) @classmethod def end(cls) -> datetime.datetime: """ Returns the start date using current year and end_date attribute. If no end_date was defined, returns the minimum datetime to ensure it's always above checked dates. """ if not cls.end_date: return datetime.datetime.max return datetime.datetime.strptime(f"{cls.end_date}/{cls.current_year()}", cls.date_format) @classmethod def is_between_dates(cls, date: datetime.datetime) -> bool: """ Determines if the given date falls between the season's date range. """ return cls.start() <= date <= cls.end() @property def name_clean(self) -> str: return self.name.replace("_", " ").title() @property def greeting(self) -> str: """ Provides a default greeting based on the season name if one wasn't defined in the season class. It's recommended to define one in most cases by overwriting this as a normal attribute in the inhertiting class. """ return f"New Season, {self.name_clean}!" async def get_icon(self, avatar: bool = False) -> bytes: """ Retrieves the icon image from the branding repository, using the defined icon attribute for the season. If `avatar` is True, uses optional bot-only avatar icon if present. The icon attribute must provide the url path, starting from the master branch base url, including the starting slash: `https://raw.githubusercontent.com/python-discord/branding/master` """ base_url = "https://raw.githubusercontent.com/python-discord/branding/master" if avatar: icon = self.bot_icon or self.icon else: icon = self.icon full_url = base_url + icon log.debug(f"Getting icon from: {full_url}") async with bot.http_session.get(full_url) as resp: return await resp.read() async def apply_username(self, *, debug: bool = False) -> Union[bool, None]: """ Applies the username for the current season. Only changes nickname if `bool` is False, otherwise only changes the nickname. Returns True if it successfully changed the username. Returns False if it failed to change the username, falling back to nick. Returns None if `debug` was True and username change wasn't attempted. """ guild = bot.get_guild(Client.guild) result = None # Change only nickname if in debug mode due to ratelimits for user edits if debug: if guild.me.display_name != self.bot_name: log.debug(f"Changing nickname to {self.bot_name}") await guild.me.edit(nick=self.bot_name) else: if bot.user.name != self.bot_name: # attempt to change user details log.debug(f"Changing username to {self.bot_name}") with contextlib.suppress(discord.HTTPException): await bot.user.edit(username=self.bot_name) # fallback on nickname if failed due to ratelimit if bot.user.name != self.bot_name: log.warning(f"Username failed to change: Changing nickname to {self.bot_name}") await guild.me.edit(nick=self.bot_name) result = False else: result = True # remove nickname if an old one exists if guild.me.nick and guild.me.nick != self.bot_name: log.debug(f"Clearing old nickname of {guild.me.nick}") await guild.me.edit(nick=None) return result async def apply_avatar(self) -> bool: """ Applies the avatar for the current season. Returns if it was successful. """ # track old avatar hash for later comparison old_avatar = bot.user.avatar # attempt the change log.debug(f"Changing avatar to {self.bot_icon or self.icon}") icon = await self.get_icon(avatar=True) with contextlib.suppress(discord.HTTPException, asyncio.TimeoutError): async with async_timeout.timeout(5): await bot.user.edit(avatar=icon) if bot.user.avatar != old_avatar: log.debug(f"Avatar changed to {self.bot_icon or self.icon}") return True log.warning(f"Changing avatar failed: {self.bot_icon or self.icon}") return False async def apply_server_icon(self) -> bool: """ Applies the server icon for the current season. Returns if it was successful. """ guild = bot.get_guild(Client.guild) # track old icon hash for later comparison old_icon = guild.icon # attempt the change log.debug(f"Changing server icon to {self.icon}") icon = await self.get_icon() with contextlib.suppress(discord.HTTPException, asyncio.TimeoutError): async with async_timeout.timeout(5): await guild.edit(icon=icon, reason=f"Seasonbot Season Change: {self.name}") new_icon = bot.get_guild(Client.guild).icon if new_icon != old_icon: log.debug(f"Server icon changed to {self.icon}") return True log.warning(f"Changing server icon failed: {self.icon}") return False async def announce_season(self): """ Announces a change in season in the announcement channel. It will skip the announcement if the current active season is the "evergreen" default season. """ # don't actually announce if reverting to normal season if self.name == "evergreen": log.debug(f"Season Changed: {self.name}") return guild = bot.get_guild(Client.guild) channel = guild.get_channel(Channels.announcements) mention = f"<@&{Roles.announcements}>" # collect seasonal cogs cogs = [] for cog in bot.cogs.values(): if "evergreen" in cog.__module__: continue cog_name = type(cog).__name__ if cog_name != "SeasonManager": cogs.append(cog_name) # no cogs, so no seasonal commands if not cogs: return # build cog info output doc = inspect.getdoc(self) announce_text = doc + "\n\n" if doc else "" def cog_name(cog): return type(cog).__name__ cog_info = [] for cog in sorted(cogs, key=cog_name): doc = inspect.getdoc(bot.get_cog(cog)) if doc: cog_info.append(f"**{cog}**\n*{doc}*") else: cog_info.append(f"**{cog}**") embed = discord.Embed(description=announce_text, colour=self.colour or guild.me.colour) embed.set_author(name=self.greeting) cogs_text = "\n".join(cog_info) embed.add_field(name="New Command Categories", value=cogs_text) embed.set_footer(text="To see the new commands, use .help Category") await channel.send(mention, embed=embed) async def load(self): """ Loads extensions, bot name and avatar, server icon and announces new season. If in debug mode, the avatar, server icon, and announcement will be skipped. """ # Prepare all the seasonal cogs, and then the evergreen ones. extensions = [] for ext_folder in {self.name, "evergreen"}: if ext_folder: log.info(f"Start loading extensions from seasons/{ext_folder}/") path = Path("bot", "seasons", ext_folder) for ext_name in [i[1] for i in pkgutil.iter_modules([path])]: extensions.append(f"bot.seasons.{ext_folder}.{ext_name}") # Finally we can load all the cogs we've prepared. bot.load_extensions(extensions) # Apply seasonal elements after extensions successfully load username_changed = await self.apply_username(debug=Client.debug) # Avoid major changes and announcements if debug mode if not Client.debug: log.info("Applying avatar.") await self.apply_avatar() if username_changed: log.info("Applying server icon.") await self.apply_server_icon() log.info(f"Announcing season {self.name}.") await self.announce_season() else: log.info(f"Skipping server icon change due to username not being changed.") log.info(f"Skipping season announcement due to username not being changed.") await bot.send_log("SeasonalBot Loaded!", f"Active Season: **{self.name_clean}**") class SeasonManager(commands.Cog): """ A cog for managing seasons. """ def __init__(self, bot): self.bot = bot self.season = get_season(date=datetime.datetime.utcnow()) self.season_task = bot.loop.create_task(self.load_seasons()) # Figure out number of seconds until a minute past midnight tomorrow = datetime.datetime.now() + datetime.timedelta(1) midnight = datetime.datetime( year=tomorrow.year, month=tomorrow.month, day=tomorrow.day, hour=0, minute=0, second=0 ) self.sleep_time = (midnight - datetime.datetime.now()).seconds + 60 async def load_seasons(self): await self.bot.wait_until_ready() await self.season.load() while True: await asyncio.sleep(self.sleep_time) # sleep until midnight self.sleep_time = 86400 # next time, sleep for 24 hours. # If the season has changed, load it. new_season = get_season(date=datetime.datetime.utcnow()) if new_season.name != self.season.name: await self.season.load() @with_role(Roles.moderator, Roles.admin, Roles.owner) @commands.command(name="season") async def change_season(self, ctx, new_season: str): """ Changes the currently active season on the bot. """ self.season = get_season(season_name=new_season) await self.season.load() await ctx.send(f"Season changed to {new_season}.") @with_role(Roles.moderator, Roles.admin, Roles.owner) @commands.command(name="seasons") async def show_seasons(self, ctx): """ Shows the available seasons and their dates. """ # sort by start order, followed by lower duration def season_key(season_class: Type[SeasonBase]): return season_class.start(), season_class.end() - datetime.datetime.max current_season = self.season.name forced_space = "\u200b " entries = [] seasons = [get_season_class(s) for s in get_seasons()] for season in sorted(seasons, key=season_key): start = season.start_date end = season.end_date if start and not end: period = f"From {start}" elif end and not start: period = f"Until {end}" elif not end and not start: period = f"Always" else: period = f"{start} to {end}" # bold period if current date matches season date range is_current = season.is_between_dates(datetime.datetime.utcnow()) pdec = "**" if is_current else "" # underline currently active season is_active = current_season == season.name sdec = "__" if is_active else "" entries.append( f"**{sdec}{season.__name__}:{sdec}**\n" f"{forced_space*3}{pdec}{period}{pdec}\n" ) embed = discord.Embed(description="\n".join(entries), colour=ctx.guild.me.colour) embed.set_author(name="Seasons") await ctx.send(embed=embed) @with_role(Roles.moderator, Roles.admin, Roles.owner) @commands.group() async def refresh(self, ctx): """ Refreshes certain seasonal elements without reloading seasons. """ if not ctx.invoked_subcommand: await ctx.invoke(bot.get_command("help"), "refresh") @refresh.command(name="avatar") async def refresh_avatar(self, ctx): """ Re-applies the bot avatar for the currently loaded season. """ # attempt the change is_changed = await self.season.apply_avatar() if is_changed: colour = ctx.guild.me.colour title = "Avatar Refreshed" else: colour = discord.Colour.red() title = "Avatar Failed to Refresh" # report back details season_name = type(self.season).__name__ embed = discord.Embed( description=f"**Season:** {season_name}\n**Avatar:** {self.season.bot_icon or self.season.icon}", colour=colour ) embed.set_author(name=title) embed.set_thumbnail(url=bot.user.avatar_url_as(format="png")) await ctx.send(embed=embed) @refresh.command(name="icon") async def refresh_server_icon(self, ctx): """ Re-applies the server icon for the currently loaded season. """ # attempt the change is_changed = await self.season.apply_server_icon() if is_changed: colour = ctx.guild.me.colour title = "Server Icon Refreshed" else: colour = discord.Colour.red() title = "Server Icon Failed to Refresh" # report back details season_name = type(self.season).__name__ embed = discord.Embed( description=f"**Season:** {season_name}\n**Icon:** {self.season.icon}", colour=colour ) embed.set_author(name=title) embed.set_thumbnail(url=bot.get_guild(Client.guild).icon_url_as(format="png")) await ctx.send(embed=embed) @refresh.command(name="username", aliases=("name",)) async def refresh_username(self, ctx): """ Re-applies the bot username for the currently loaded season. """ old_username = str(bot.user) old_display_name = ctx.guild.me.display_name # attempt the change is_changed = await self.season.apply_username() if is_changed: colour = ctx.guild.me.colour title = "Username Refreshed" changed_element = "Username" old_name = old_username new_name = str(bot.user) else: colour = discord.Colour.red() # if None, it's because it wasn't meant to change username if is_changed is None: title = "Nickname Refreshed" else: title = "Username Failed to Refresh" changed_element = "Nickname" old_name = old_display_name new_name = self.season.bot_name # report back details season_name = type(self.season).__name__ embed = discord.Embed( description=f"**Season:** {season_name}\n" f"**Old {changed_element}:** {old_name}\n" f"**New {changed_element}:** {new_name}", colour=colour ) embed.set_author(name=title) await ctx.send(embed=embed) @with_role(Roles.moderator, Roles.admin, Roles.owner) @commands.command() async def announce(self, ctx): """ Announces the currently loaded season. """ await self.season.announce_season() def __unload(self): self.season_task.cancel()