Merge branch '36-bot-presence'

bot_messages/highcouncil_election.txt

@@ -7,7 +7,6 @@ From {highcouncil_election_announce} to {highcouncil_election_start}, you will b
  Clan Leader
  Discord Server Manager
 
-Each member of the CCE can cast one for each category by using the emotes:  <:Rank_Owner:479008325137072155>  for Clan Leader and <:Rank_Deputy:479008295319896064>  for Discord Server Manager.
-If needed, the icon 🤷 can be used to abstain to vote in any or both categories and it should be applied to all candidates of that category.
+Each member of the CCE can vote once in each category (Discord Server Manager and Clan Leader). Alternatively, you may choose to intentionally abstain.
 
 Votes can be cast until {highcouncil_election_end}, so we can announce and have everyone set up to start the term by {term_start}.

classes/election_cycle.py

@@ -201,16 +201,9 @@ class ElectionCycle:
 
         thread_msg: nextcord.Message = await parent.send(content=quarter_name)
 
-        # create new entry into database.
         thread: nextcord.Thread = await parent.create_thread(
             name=quarter_name, message=thread_msg
         )
-        with Session(engine) as session:
-            new_cycle = ElectionInformation(
-                ElectionCycle=quarter_name, ThreadId=thread.id
-            )
-            session.add(new_cycle)
-            session.commit()
 
         # post message announcing election
         # election start message is returned as an array of string because it is too long. send each string
@@ -219,10 +212,22 @@ class ElectionCycle:
         for index, message in enumerate(messages):
             # if last item, add the nominate button
             if index + 1 == len(messages):
-                await thread.send(message, view=NominateView(self.config, self.guild))
+                nominate_msg: nextcord.Message = await thread.send(
+                    message, view=NominateView(self.config, self.guild)
+                )
             else:
                 await thread.send(message)
 
+        # create new entry into database.
+        with Session(engine) as session:
+            new_cycle = ElectionInformation(
+                ElectionCycle=quarter_name,
+                ThreadId=thread.id,
+                CouncilNominationMsgId=nominate_msg.id,
+            )
+            session.add(new_cycle)
+            session.commit()
+
     async def voting_start_action(self) -> None:
         """
         Sends message informing members that voting has started.
@@ -246,6 +251,12 @@ class ElectionCycle:
             info.CouncilVoteMsgId = vote_msg.id
             session.commit()
 
+            thread: nextcord.Thread = self.guild.get_thread(info.ThreadId)
+            nominate_msg: nextcord.Message = await thread.fetch_message(
+                info.CouncilNominationMsgId
+            )
+            await nominate_msg.edit(view=None)
+
     async def voting_end_action(self) -> None:
         """
         Performs required actions for when voting time has ended.
@@ -259,18 +270,28 @@ class ElectionCycle:
             self.get_election_info().ThreadId
         )
 
-        # remove vote button from vote message
+        nominate_msg: nextcord.Message = await election_thread.send(
+            message, view=NominateHighCouncilView(self.config, self.guild)
+        )
+
         election_name = get_election_cycle_name(self.config)
+
         with Session(engine) as session:
-            stmt = select(ElectionInformation.CouncilVoteMsgId).where(
+            # remove vote button from vote message
+            stmt = select(ElectionInformation).where(
                 ElectionInformation.ElectionCycle == election_name
             )
-            vote_msg_id = session.scalar(stmt)
-        vote_msg: nextcord.Message = await election_thread.fetch_message(vote_msg_id)
-        await vote_msg.edit(view=None)
+            info = session.scalar(stmt)
+            vote_msg: nextcord.Message = await election_thread.fetch_message(
+                info.CouncilVoteMsgId
+            )
+            await vote_msg.edit(view=None)
 
-        # add the highcouncil role to everyone with 3 or more votes. set elected to true in database
-        with Session(engine) as session:
+            # add the highcouncil nomination message to election information
+            info.HighCouncilNominationMsgId = nominate_msg.id
+            session.commit()
+
+            # add the highcouncil role to everyone with 3 or more votes. set elected to true in database
             stmt = select(Votes.VotedForId).where(Votes.ElectionCycle == election_name)
             vote_count = collections.Counter(session.scalars(stmt))
 
@@ -292,10 +313,6 @@ class ElectionCycle:
                         reason=f"{member.display_name} has won a nomination and become a Council Elect.",
                     )
 
-        await election_thread.send(
-            message, view=NominateHighCouncilView(self.config, self.guild)
-        )
-
     async def highcouncil_election_start_action(self) -> None:
         """
         Performs required actions for when the highcouncil is elected.
@@ -320,6 +337,12 @@ class ElectionCycle:
             info.HighCouncilVoteMsgId = vote_msg.id
             session.commit()
 
+            # remove highcouncil nomination view
+            nomination_msg: nextcord.Message = await election_thread.fetch_message(
+                info.HighCouncilNominationMsgId
+            )
+            await nomination_msg.edit(view=None)
+
     async def term_start_action(self) -> None:
         """
         Marks the election as over.
@@ -364,8 +387,14 @@ class ElectionCycle:
             stmt = select(Votes.VotedForId).where(Votes.ElectionCycle == cl_election)
             cl_votes = collections.Counter(session.scalars(stmt))
 
-            dm_winner = max(dm_votes, key=dm_votes.get)
-            cl_winner = max(cl_votes, key=cl_votes.get)
+            try:
+                dm_winner = max(dm_votes, key=dm_votes.get)
+            except ValueError:
+                dm_winner = "No winner"
+            try:
+                cl_winner = max(cl_votes, key=cl_votes.get)
+            except ValueError:
+                cl_winner = "No winner"
 
         election_thread: nextcord.Thread = self.guild.get_thread(
             self.get_election_info().ThreadId

cogs/commands/request.py

@@ -4,8 +4,10 @@ Contains commands and views for request commands.
 
 import nextcord
 from nextcord.ext import commands
+from sqlalchemy.orm import Session
 
 from config import DakinyConfig
+from database_setup.sql_data_classes import Presences, engine
 
 
 class RequestCog(commands.Cog, name="Request Commands"):
@@ -25,12 +27,46 @@ class RequestCog(commands.Cog, name="Request Commands"):
         Parent slash command for help. Never called.
         """
 
+    @request.subcommand(
+        description="Request to add a presence to the bot's presence list."
+    )
+    async def add_presence(
+        self,
+        interaction: nextcord.Interaction,
+        presence: str = nextcord.SlashOption(
+            required=True,
+            min_length=1,
+            max_length=100,
+            description="The presence you want to add.",
+        ),
+    ):
+        """
+        Sends a message to admins to request to add a presence.
+
+        Args:
+            interaction (nextcord.Interaction): Interaction that invoked the command.
+            presence (str): The presence to add.
+        """
+
+        config: DakinyConfig = self.bot.config
+        content = f'<@{interaction.user.id}> would like to add presence"{presence}."'
+        view = PresenceChange(presence)
+        await self.bot.get_channel(config.params.admin_channel_id).send(
+            content=content, view=view
+        )
+        await interaction.response.send_message(
+            "Request sent to admins.", ephemeral=True
+        )
+
     @request.subcommand(description="Request to change your Dakiny nickname")
     async def change_nickname(
         self,
         interaction: nextcord.Interaction,
         new_nickname: str = nextcord.SlashOption(
-            required=True, min_length=2, max_length=32, description="Your requested new nickname."
+            required=True,
+            min_length=2,
+            max_length=32,
+            description="Your requested new nickname.",
         ),
     ):
         """
@@ -44,8 +80,12 @@ class RequestCog(commands.Cog, name="Request Commands"):
         config: DakinyConfig = self.bot.config
         content = f'<@{interaction.user.id}> would like to change their username to "{new_nickname}."'
         view = UsernameRequest(interaction.user.id, new_nickname)
-        await self.bot.get_channel(config.params.admin_channel_id).send(content=content, view=view)
-        await interaction.response.send_message("Request sent to admins.", ephemeral=True)
+        await self.bot.get_channel(config.params.admin_channel_id).send(
+            content=content, view=view
+        )
+        await interaction.response.send_message(
+            "Request sent to admins.", ephemeral=True
+        )
 
 
 class UsernameRequest(nextcord.ui.View):
@@ -53,13 +93,19 @@ class UsernameRequest(nextcord.ui.View):
     View provides approve and deny buttons and action for a username change request.
     """
 
-    def __init__(self, user_id: int, new_nickname: str, *, timeout: float | None = 180, auto_defer: bool = True):
-        super().__init__(timeout=timeout, auto_defer=auto_defer)
+    def __init__(
+        self,
+        user_id: int,
+        new_nickname: str,
+    ):
+        super().__init__(timeout=None, auto_defer=True)
         self.user_id = user_id
         self.new_nickname = new_nickname
 
     @nextcord.ui.button(label="Approve", style=nextcord.ButtonStyle.green)
-    async def approve(self, button: nextcord.ui.Button, interaction: nextcord.Interaction):
+    async def approve(
+        self, button: nextcord.ui.Button, interaction: nextcord.Interaction
+    ):
         """
         Approve button for a nickname change request. Changes the target's nickname to self.new_nickname.
         Catches an error if the target as a higher role than the bot.
@@ -73,7 +119,10 @@ class UsernameRequest(nextcord.ui.View):
         if user is not None:
             try:
                 await user.edit(nick=self.new_nickname)
-                content = interaction.message.content + f"\nApproved by <@{interaction.user.id}>."
+                content = (
+                    interaction.message.content
+                    + f"\nApproved by <@{interaction.user.id}>."
+                )
                 await interaction.response.edit_message(content=content, view=None)
             except nextcord.errors.Forbidden:
                 await interaction.response.send_message(
@@ -84,10 +133,13 @@ class UsernameRequest(nextcord.ui.View):
                     interaction.message.content
                     + "\n\nFailed. User has too high permissions for bot to change nickname."
                 )
-                await interaction.followup.edit_message(interaction.message.id, content=content, view=None)
+                await interaction.followup.edit_message(
+                    interaction.message.id, content=content, view=None
+                )
         else:
             await interaction.response.edit_message(
-                content="An error occured while changing the user's nickname.", view=None
+                content="An error occured while changing the user's nickname.",
+                view=None,
             )
 
     @nextcord.ui.button(label="Deny", style=nextcord.ButtonStyle.red)
@@ -101,3 +153,50 @@ class UsernameRequest(nextcord.ui.View):
         """
         content = interaction.message.content + f"\nDenied by <@{interaction.user.id}>."
         await interaction.response.edit_message(content=content, view=None)
+
+
+class PresenceChange(nextcord.ui.View):
+    """
+    View provides approve and deny buttons and action for a username change request.
+    """
+
+    def __init__(
+        self,
+        presence: str,
+    ):
+        super().__init__(timeout=None, auto_defer=True)
+        self.presence = presence
+
+    @nextcord.ui.button(label="Approve", style=nextcord.ButtonStyle.green)
+    async def approve(
+        self, button: nextcord.ui.Button, interaction: nextcord.Interaction
+    ):
+        """
+        Approve button for a presence add request. Adds the presence to the database.
+        Removes the view from the interaction message.
+
+        Args:
+            button (nextcord.ui.Button): Unused.
+            interaction (nextcord.Interaction): The interaction of the user clicking the button.
+        """
+
+        with Session(engine) as session:
+            session.add(Presences(Presence=self.presence))
+            session.commit()
+
+        content = (
+            interaction.message.content + f"\nApproved by <@{interaction.user.id}>."
+        )
+        await interaction.response.edit_message(content=content, view=None)
+
+    @nextcord.ui.button(label="Deny", style=nextcord.ButtonStyle.red)
+    async def deny(self, button: nextcord.ui.Button, interaction: nextcord.Interaction):
+        """
+        Deny button for a presence add request. Just removes the view and logs who denied the request.
+
+        Args:
+            button (nextcord.ui.Button): Unused.
+            interaction (nextcord.Interaction): The interaction of the user clicking the button.
+        """
+        content = interaction.message.content + f"\nDenied by <@{interaction.user.id}>."
+        await interaction.response.edit_message(content=content, view=None)

cogs/loops/__init__.py

@@ -4,7 +4,8 @@ Initializing code for all loops.
 
 from nextcord.ext import commands
 
-from .daily_loop import DailyLoop
+from cogs.loops.bot_presence import BotPresence
+from cogs.loops.daily_loop import DailyLoop
 
 
 def setup(bot: commands.Bot):
@@ -12,4 +13,5 @@ def setup(bot: commands.Bot):
     Adds functions to bot.
     """
 
+    bot.add_cog(BotPresence(bot))
     bot.add_cog(DailyLoop(bot))

cogs/loops/bot_presence.py

@@ -0,0 +1,48 @@
+"""
+Functions for controlling the bot's presence. Also contains the loop.
+"""
+
+import nextcord
+from nextcord.ext import commands, tasks
+from sqlalchemy import func, select
+from sqlalchemy.orm import Session
+
+from database_setup.sql_data_classes import Presences, engine
+
+
+class BotPresence(commands.Cog, name="Bot Presence"):
+    """Class for bot presence functions."""
+
+    def __init__(self, bot: commands.Bot):
+        self.bot = bot
+
+    @commands.Cog.listener()
+    async def on_guild_join(
+        self, guild: nextcord.Guild
+    ):  # pylint: disable=unused-argument
+        """Listener for Guild Join. Updated presence on guild join."""
+        await self.change_presence()
+
+    @commands.Cog.listener()
+    async def on_ready(self):
+        """Starts the loop when bot is ready."""
+        await self.bot.wait_until_ready()
+        # pylint doesn't recognize that periodic_change_presense is subclassed from tasks.loop.
+        self.periodic_change_presence.start()  # pylint: disable=no-member
+
+    @tasks.loop(minutes=5)
+    async def periodic_change_presence(self):
+        """Loops every 5 minutes and changes presence."""
+        await self.change_presence()
+
+    async def change_presence(self):
+        """Randomly chooses a presence and updates bot's presence."""
+
+        with Session(engine) as session:
+            presence = session.scalar(
+                select(Presences.Presence).order_by(func.random())
+            )
+
+        await self.bot.change_presence(
+            activity=nextcord.CustomActivity(name="Custom Status", state=presence)
+        )

database_setup/database.sql

@@ -3,6 +3,8 @@ CREATE TABLE ElectionInformation(
     ThreadId bigint unsigned not null,
     CouncilVoteMsgId bigint unsigned,
     HighCouncilVoteMsgId bigint unsigned,
+    CouncilNominationMsgId bigint unsigned,
+    HighCouncilNominationMsgId bigint unsigned,
     PRIMARY KEY (ElectionCycle)
 );
 
@@ -31,4 +33,9 @@ CREATE TABLE UserBirthday (
     UserId bigint unsigned not null,
     Birthday varchar(5) not null,
     PRIMARY KEY (UserId)
+);
+
+CREATE TABLE Presences (
+    Id integer PRIMARY KEY,
+    Presence varchar(100) not null
 );

database_setup/sql_data_classes.py

@@ -15,3 +15,4 @@ ElectionInformation = Base.classes.ElectionInformation
 CouncilMembers = Base.classes.CouncilMembers
 Votes = Base.classes.Votes
 UserBirthday = Base.classes.UserBirthday
+Presences = Base.classes.Presences