Added doc strings for the approve and deny buttons.

This reverts commit a52979a847.

.gitea/workflows/build_develop.yml

@@ -12,6 +12,12 @@ jobs:
           fetch-depth: 0
       - name: Install Docker
         uses: https://github.com/papodaca/install-docker-action@v1
+      - name: Log into container registry
+        uses: docker/login-action@v2
+        with:
+          registry: gitea.cheezers.org
+          username: imcompiling
+          password: ${{ secrets.PASSWORD }}
       - name: Build Docker Image
         run: docker build -t gitea.cheezers.org/imcompiling/dakiny-bot:develop .
       - name: Push Docker Image

.gitea/workflows/build_latest.yml

@@ -14,6 +14,12 @@ jobs:
           fetch-depth: 0
       - name: Install Docker
         uses: https://github.com/papodaca/install-docker-action@v1
+      - name: Log into container registry
+        uses: docker/login-action@v2
+        with:
+          registry: gitea.cheezers.org
+          username: imcompiling
+          password: ${{ secrets.PASSWORD }}
       - name: Build Docker Image
         run: docker build -t gitea.cheezers.org/imcompiling/dakiny-bot:latest .
       - name: Push Docker Image

.gitignore

@@ -139,3 +139,4 @@ TODO.txt
 sql_tester.py
 conf
 outputs
+dakiny.db

README.md

@@ -1,50 +1,5 @@
-# Discord Bot Template
+# Dakiny Bot
 
-[![Discord](https://img.shields.io/discord/819650821314052106?color=7289DA&logo=discord&logoColor=white)](https://discord.gg/fPrdqh3Zfu "Dev Pro Tips Discussion & Support Server")
-[![Powered by Nextcord](https://custom-icon-badges.herokuapp.com/badge/-Powered%20by%20Nextcord-0d1620?logo=nextcord)](https://github.com/nextcord/nextcord "Powered by Nextcord Python API Wrapper")
-
-This repo is a template for easy creation of maintainable Python Discord bots.
-
-The library used is [Nextcord](https://github.com/nextcord/nextcord), a maintained fork of Discord.py.
-
-Nextcord documentation: https://nextcord.readthedocs.io/en/latest/
-
-📺 Python Discord Tutorial: https://www.youtube.com/playlist?list=PL9YUC9AZJGFG6larkQJYio_f0V-O1NRjy
-
-## How to use
-
-Click "use this template" at the top of this repo and follow the instructions, or alternatively, initialize a git repo and copy the template files into the directory.
-
-```bash
-# Create a new folder (replace my-discord-bot with your bot's name)
-mkdir my-discord-bot && cd my-discord-bot
-# Initialize the folder as a git repository and copy the template files
-git init
-cp ../discord-bot-template/* .
-```
-
-## Environment variables
-
-To run your bot, you'll need a token and other secrets set in a `.env` file.
-
-Create a file called `.env` and place it in the root of your project.
-
-(You can do this by creating a copy of `.env.sample` and renaming it to `.env`)
-
-The contents should look something like this (where the part after `=` is the token you received from the Discord Developer Portal)
-
-```
-DISCORD_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-```
-
-If you require additional API keys or variables specific to an enviroment, they should also be added here. You can access them by adding a line such as `GUILD_ID = os.getenv("GUILD_ID", "")` to `config.py`.
-
-## Heroku
-
-`runtime.txt` and `Procfile` are used for Heroku configuration and can be deleted in case you do not plan on hosting there.
-
-Heroku setup tutorial: https://www.youtube.com/watch?v=EreE-0hQibM
-
-## IDE Configuration
-
-IDE config such as the `.vscode` folder do not normally belong on GitHub since they are often specific to a particular environment. To make sure GitHub will ignore the `.vscode` folder uncomment the line at the end of the `.gitignore`.
+Bot assumes that it always did the step before it. If the step before an action didn't happen, behavior is undefined.
+Object creation in the middle of a cycle is only there for restarting the bot. All relevant information should already
+exist in the database.

bot_messages/highcouncil_election.txt

@@ -10,4 +10,4 @@ From {highcouncil_election_announce} to {highcouncil_election_start}, you will b
 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 apply to all candidates of that category.
 
-Votes can be cast until the {highcouncil_election_end}, so we can announce and have everyone set up to start the term by {term_start}
+Votes can be cast until the {highcouncil_election_end}, so we can announce and have everyone set up to start the term by {term_start}.

bot_messages/highcouncil_vote.txt

@@ -0,0 +1 @@
+<@&{clan_council_elect_role_id}> it is now time to vote for the high council! You have until {term_start} to complete the vote.

classes/election_cycle.py

@@ -5,9 +5,11 @@ Contains the election cycle class
 from datetime import datetime, timedelta
 
 import nextcord
-from nextcord.ext import commands
+from sqlalchemy import select
+from sqlalchemy.orm import Session
 
 from config import DakinyConfig
+from database.sql_data_classes import ElectionInformation, engine
 from utils import get_datetime
 
 
@@ -17,7 +19,7 @@ class ElectionCycle:
     the cycle.
     """
 
-    def __init__(self, cycle: int, bot) -> None:
+    def __init__(self, cycle: int, config: DakinyConfig, guild: nextcord.Guild) -> None:
         """
         Generates all dates relevant to the election cycle from input election start, term start and end dates.
 
@@ -27,7 +29,7 @@ class ElectionCycle:
             term_end (datetime): Date the term being elected ends.
             bot: the discord bot instance
         """
-        self.config: DakinyConfig = bot.config
+        self.config: DakinyConfig = config
         self.cycle = cycle
         self.elecion_cycle = self.config.election_cycles[self.cycle]
         self.election_start: datetime = get_datetime(self.elecion_cycle.election_start)
@@ -38,7 +40,8 @@ class ElectionCycle:
         self.highcouncil_election_announce: datetime = self.voting_end + timedelta(days=1)
         self.highcouncil_election_start: datetime = self.highcouncil_election_announce + timedelta(days=3)
         self.highcouncil_election_end: datetime = self.term_start - timedelta(days=1)
-        self.bot: commands.Bot = bot
+        self.guild: nextcord.Guild = guild
+        self.election_over: bool = False
 
     def build_election_announcement(self) -> list[str]:
         """
@@ -68,7 +71,7 @@ class ElectionCycle:
 
             return message.split("---message_break---")
 
-    def build_highcouncil_election(self) -> str:
+    def build_highcouncil_election_announce(self) -> str:
         """
         Builds message to announce highcouncil election start.
 
@@ -79,7 +82,29 @@ class ElectionCycle:
         with open("bot_messages/highcouncil_election.txt", mode="r", encoding="utf8") as file:
             message = file.read()
 
-            return message.format()
+            return message.format(
+                clan_council_elect_role_id=self.config.params.clan_council_elect_role_id,
+                highcouncil_election_announce=self.highcouncil_election_announce.strftime("%B %d"),
+                highcouncil_election_start=self.highcouncil_election_start.strftime("%B %d"),
+                highcouncil_election_end=self.highcouncil_election_end.strftime("%B %d"),
+                term_start_date=self.term_start.strftime("%B %d"),
+            )
+
+    def build_highcouncil_vote_start(self) -> str:
+        """
+        Builds the message to announce that highcouncil voting has started.
+
+        Returns:
+            str: Message to send.
+        """
+
+        with open("bot_messages/highcouncil_vote.txt", mode="r", encoding="utf8") as file:
+            message = file.read()
+
+            return message.format(
+                clan_council_elect_role_id=self.config.params.clan_council_elect_role_id,
+                term_start_date=self.term_start.strftime("%B %d"),
+            )
 
     def build_vote_start(self) -> str:
         """
@@ -105,7 +130,6 @@ class ElectionCycle:
         Function checks current date to see if something needs to be run.
         """
         today = datetime.today()
-        print("checking the date")
 
         # check all dates if action is needed
         if today.date() == self.election_start.date():
@@ -115,68 +139,94 @@ class ElectionCycle:
         elif today.date() == self.voting_end.date():
             await self.voting_end_action()
         elif today.date() == self.highcouncil_election_start.date():
-            await self.highcouncil_election_action()
+            await self.highcouncil_election_start_action()
         elif today.date() == self.term_start.date():
             await self.term_start_action()
-        elif today.date() == self.term_end.date():
-            await self.term_end_action()
-        else:
-            print("today was not a special date")
-            print(today)
 
     async def election_start_action(self) -> None:
         """
         Performs required actions for when the election cycle starts.
         """
-        print("election cycle has started")
         # create new channel for election
-        category: nextcord.CategoryChannel = self.bot.get_channel(self.config.params.active_category_id)
-        quarter_name: str = str(datetime.today().year) + "-" + self.elecion_cycle.name + "-election"
-        # TODO need to store this id in the sqlite database
-        election_channel = await category.create_text_channel(quarter_name)
+        category: nextcord.CategoryChannel = self.guild.get_channel(self.config.params.active_category_id)
+        quarter_name: str = self.get_election_cycle_name()
+
+        # create new entry into database.
+        election_channel: nextcord.TextChannel = await category.create_text_channel(quarter_name)
+        with Session(engine) as session:
+            new_cycle = ElectionInformation(ElectionCycle=quarter_name, ElectionChannel=election_channel.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
         # individually.
         messages = self.build_election_announcement()
-
         for message in messages:
             await election_channel.send(message)
 
     async def voting_start_action(self) -> None:
         """
-        Performs required actions for when voting for candidates starts.
+        Sends message informing members that voting has started.
+        Removes write permission from the general clan member role.
+        Adds the voting emote to all messages not sent by the vote. (This is temporary until voting is managed.)
         """
-        print("Voting has started")
-        await self.message_me("Voting has started")
+        message = self.build_vote_start()
+        clan_member_role: nextcord.Role = self.guild.get_role(self.config.params.clan_member_role_id)
+        election_channel: nextcord.TextChannel = self.guild.get_channel(self.get_election_info().ElectionChannel)
+        await election_channel.send(message)
+        await election_channel.set_permissions(clan_member_role, send_messages=False)
 
     async def voting_end_action(self) -> None:
         """
         Performs required actions for when voting time has ended.
         """
-        print("voting has ended")
-        await self.message_me("voting has ended")
+        message = self.build_highcouncil_election_announce()
+        council_elect_role: nextcord.Role = self.guild.get_role(self.config.params.clan_council_elect_role_id)
+        election_channel: nextcord.TextChannel = self.guild.get_channel(self.get_election_info().ElectionChannel)
+        await election_channel.send(message)
+        await election_channel.set_permissions(council_elect_role, send_messages=True)
 
-    async def highcouncil_election_action(self) -> None:
+    async def highcouncil_election_start_action(self) -> None:
         """
         Performs required actions for when the highcouncil is elected.
         """
-        print("Highcouncil election has started.")
-        await self.message_me("Highcouncil election has started.")
+
+        message = self.build_highcouncil_vote_start()
+        election_channel: nextcord.TextChannel = self.guild.get_channel(self.get_election_info().ElectionChannel)
+        await election_channel.send(message)
 
     async def term_start_action(self) -> None:
-        msg: str = "the term has started"
-        print(msg)
-        self.message_me(msg)
-
-    async def term_end_action(self):
-        msg: str = "the term has ended"
-        print(msg)
-        self.message_me(msg)
-
-    async def message_me(self, msg: str):
         """
-        message a string to me
+        Moves the election channel into the archive category.
         """
-        imcompiling: nextcord.User = await self.bot.fetch_user(206602713511886849)
-        await imcompiling.send(msg)
+
+        self.election_over = True
+        election_channel: nextcord.TextChannel = self.guild.get_channel(self.get_election_info().ElectionChannel)
+        archive: nextcord.CategoryChannel = self.guild.get_channel(self.config.params.archive_channel_group_id)
+
+        await election_channel.move(beginning=True, category=archive)
+
+    def get_election_cycle_name(self) -> str:
+        """
+        Builds the unique name of the current election cycle
+
+        Returns:
+            str: the name of the election cycle
+        """
+
+        return f"{self.election_start.year} {self.elecion_cycle.name} election"
+
+    def get_election_info(self) -> ElectionInformation:
+        """
+        Gets information for current election.
+
+        Returns:
+            ElectionInformation: The information from the database about the current election.
+        """
+
+        with Session(engine) as session:
+            stmt = select(ElectionInformation).where(
+                ElectionInformation.ElectionCycle == self.get_election_cycle_name()
+            )
+            return session.scalar(stmt)

cogs/commands/__init__.py

@@ -4,6 +4,7 @@ Cog loader. Adds all command cogs to the bot.
 
 from nextcord.ext import commands
 
+from cogs.commands.request import RequestCog
 from cogs.commands.test import TestCog
 
 
@@ -13,4 +14,5 @@ def setup(bot: commands.Bot):
     """
     Adds all command classes to bot.
     """
+    bot.add_cog(RequestCog(bot))
     bot.add_cog(TestCog(bot))

cogs/commands/request.py

@@ -0,0 +1,103 @@
+"""
+Contains commands and views for request commands.
+"""
+
+import nextcord
+from nextcord.ext import commands
+
+from config import DakinyConfig
+
+
+class RequestCog(commands.Cog, name="Request Commands"):
+    """
+    Class holds request commands.
+    """
+
+    def __init__(self, bot) -> None:
+        """
+        Default constructor for RequestCog class. Does nothing.
+        """
+        self.bot: commands.Bot = bot
+
+    @nextcord.slash_command()
+    async def request(self, interaction: nextcord.Interaction):
+        """
+        Parent slash command for help. Never called.
+        """
+
+    @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."
+        ),
+    ):
+        """
+        Sends a message to admins to request a nickname change.
+
+        Args:
+            interaction (nextcord.Interaction): Interaction that invoked the command.
+            new_username(str): The username to change to.
+        """
+
+        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)
+
+
+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)
+        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):
+        """
+        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.
+        Removes the view from the interaction message.
+
+        Args:
+            button (nextcord.ui.Button): Unused.
+            interaction (nextcord.Interaction): The interaction of the user clicking the button.
+        """
+        user = interaction.guild.get_member(self.user_id)
+        if user is not None:
+            try:
+                await user.edit(nick=self.new_nickname)
+                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(
+                    content="Please change manually.",
+                    ephemeral=True,
+                )
+                content = (
+                    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)
+        else:
+            await interaction.response.edit_message(
+                content="An error occured while changing the user's nickname.", 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 nickname 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/commands/test.py

@@ -53,3 +53,14 @@ class TestCog(commands.Cog, name="Test commands."):
 
         cycle = ElectionCycle(0, self.bot)
         await cycle.election_start_action()
+
+    @test.subcommand()
+    async def voting_start(self, interaction: nextcord.Interaction):
+        """
+        tests the voting start action
+
+        Args:
+            interaction (nextcord.Interaction): _description_
+        """
+        cycle = ElectionCycle(0, self.bot)
+        await cycle.voting_start_action()

cogs/loops/daily_loop.py

@@ -1,13 +1,15 @@
 """
-_summary_
+Defines the daily loop that runs the Dakiny bot functions.
 """
 
-from datetime import time
+from datetime import datetime, time
 
 from nextcord.ext import commands, tasks
 from pytz import timezone
 
 from classes.election_cycle import ElectionCycle
+from config import DakinyConfig
+from utils import get_datetime
 
 
 class DailyLoop(commands.Cog, name="Daily Loop"):
@@ -17,8 +19,7 @@ class DailyLoop(commands.Cog, name="Daily Loop"):
 
     def __init__(self, bot: commands.Bot) -> None:
         self.bot = bot
-        # TODO need to figure out how to determine the current cycle
-        self.current_election = ElectionCycle(0, self.bot)
+        self.current_election = self.get_current_cycle()
 
     @commands.Cog.listener()
     async def on_ready(self):
@@ -27,11 +28,42 @@ class DailyLoop(commands.Cog, name="Daily Loop"):
         """
         await self.bot.wait_until_ready()
         # pylint doesn't recognize that periodic_update_guild_data is subclassed from tasks.loop.
-        await self.do_thing.start()  # pylint: disable=no-member
+        await self.daily_loop.start()  # pylint: disable=no-member
 
     @tasks.loop(time=time(hour=0, tzinfo=timezone("GMT")))
-    async def do_thing(self):
-        """ """
-        print("loop")
-        await self.current_election.check_date()
-        # TODO need to figure out how to change the election cycle after current one is over
+    async def daily_loop(self):
+        """
+        Runs daily. Checks if the current election is None. If so, checks if there is an active election. If there is
+        an active election, runs the check_date() function for the election to perform actions. Finally checks if the
+        election is over to delete the current election object.
+        """
+
+        if self.current_election is None:
+            self.current_election = self.get_current_cycle()
+
+        if self.current_election is not None:
+            await self.current_election.check_date()
+            if self.current_election.election_over:
+                self.current_election = None
+
+    def get_current_cycle(self) -> ElectionCycle:
+        """
+        Creates an object for the current election cycle if one is active. An election is considered active
+        between the election start and the term start.
+
+        Returns:
+            ElectionCycle: Current election cycle, None if there is no election happening.
+        """
+
+        today = datetime.today()
+        config: DakinyConfig = self.bot.config
+        current_election = None
+
+        for cycle, election in enumerate(config.election_cycles):
+            if (
+                today.date() > get_datetime(election.election_start).date()
+                and today.date() < get_datetime(election.term_start).date()
+            ):
+                current_election = ElectionCycle(cycle, config, self.bot.get_guild(config.params.guild_id))
+
+        return current_election

config.py

@@ -11,6 +11,7 @@ class Params:
     """
 
     active_category_id: int
+    admin_channel_id: int
     annoucement_category_id: int
     archive_channel_group_id: int
     clan_council_elect_role_id: int
@@ -18,6 +19,7 @@ class Params:
     clan_info_channel_id: int
     clan_member_role_id: int
     discord_token: str
+    guild_id: int
     high_council_role_id: int
     voting_emote_id: str
 

dakiny_bot.py

@@ -6,6 +6,7 @@ import nextcord
 from hydra.core.config_store import ConfigStore
 from nextcord.ext import commands
 
+import database.create_database as create_database
 from config import DakinyConfig
 
 cs = ConfigStore.instance()
@@ -25,7 +26,7 @@ def main(cfg: DakinyConfig):
     # intents.guilds = True
 
     # To enable the members priveleged intent:
-    # intents.members = True
+    intents.members = True
 
     bot = commands.Bot(intents=intents)
     bot.config = cfg
@@ -38,6 +39,7 @@ def main(cfg: DakinyConfig):
     async def on_ready():
         """When Discord is connected"""
         assert bot.user is not None
+        create_database  # pylint: disable=pointless-statement
         print(f"{bot.user.name} has connected to Discord!")
 
     # Run Discord bot

database/create_database.py

@@ -0,0 +1,15 @@
+"""
+Small script to create the database if it doesn't already exist.
+"""
+
+import sqlite3
+from os.path import exists
+
+if not exists("dakiny.db"):
+    with sqlite3.connect("dakiny.db") as con:
+        cur = con.cursor()
+
+        with open("database/database.sql", mode="r", encoding="utf-8") as file:
+            database_script = file.read()
+            cur.executescript(database_script)
+            con.commit()

database/database.sql

@@ -0,0 +1,27 @@
+-- CREATE DATABASE dakiny;
+-- use dakiny;
+
+CREATE TABLE ElectionInformation(
+    ElectionCycle varchar(30) not null unique,
+    ElectionChannel bigint unsigned not null,
+    PRIMARY KEY (ElectionCycle)
+);
+
+CREATE TABLE CouncilMembers(
+    ElectionCycle varchar(30) not null unique,
+    MemberId bigint unsigned not null,
+    Elected boolean DEFAULT false,
+    HighCouncilElect boolean DEFAULT false,
+    DiscordManager boolean DEFAULT false,
+    ClanLeader boolean DEFAULT false,
+    FOREIGN KEY (ElectionCycle) REFERENCES ElectionInformation(ElectionCycle),
+    PRIMARY KEY (ElectionCycle, MemberId)
+);
+
+CREATE TABLE Votes(
+    ElectionCycle varchar(30) not null unique,
+    VoterId bigint unsigned not null,
+    VotedForId bigint unsigned not null,
+    FOREIGN KEY (ElectionCycle) REFERENCES ElectionInformation(ElectionCycle),
+    PRIMARY KEY (ElectionCycle, VoterId)
+);

database/sql_data_classes.py

@@ -0,0 +1,16 @@
+"""
+Simple file to set up the sqlalchemy connection to database.
+"""
+from sqlalchemy import create_engine
+from sqlalchemy.ext.automap import automap_base
+
+# connect with sql alchemy and autoload schema
+URL = "sqlite+pysqlite:///dakiny.db"
+engine = create_engine(URL)
+Base = automap_base()
+Base.prepare(autoload_with=engine)
+
+# define the classes
+ElectionInformation = Base.classes.ElectionInformation
+CouncilMembers = Base.classes.CouncilMembers
+Votes = Base.classes.Votes

permissions_required.txt

@@ -1,3 +1,6 @@
 Discord permissions required for bot to operate:
 
 manage channels
+manage roles
+manage nicknames
+need member intent

requirements.txt

@@ -2,3 +2,4 @@ nextcord==2.4.2
 python-dotenv==1.0.0
 pytz==2022.7.1
 hydra-core==1.3.2
+sqlalchemy<2.0