Make Member Modal implementation

cogs/__init__.py

@@ -35,7 +35,7 @@
 from .invite_link import InviteLinkCommandCog
 from .kill import KillCommandCog
 from .make_applicant import MakeApplicantContextCommandsCog, MakeApplicantSlashCommandCog
-from .make_member import MakeMemberCommandCog, MemberCountCommandCog
+from .make_member import MakeMemberCommandCog, MakeMemberModalCommandCog, MemberCountCommandCog
 from .ping import PingCommandCog
 from .remind_me import ClearRemindersBacklogTaskCog, RemindMeCommandCog
 from .send_get_roles_reminders import SendGetRolesRemindersTaskCog
@@ -75,6 +75,7 @@
     "MakeApplicantContextCommandsCog",
     "MakeApplicantSlashCommandCog",
     "MakeMemberCommandCog",
+    "MakeMemberModalCommandCog",
     "ManualModerationCog",
     "MemberCountCommandCog",
     "PingCommandCog",
@@ -118,6 +119,7 @@ def setup(bot: "TeXBot") -> None:
         MakeMemberCommandCog,
         ManualModerationCog,
         MemberCountCommandCog,
+        MakeMemberModalCommandCog,
         PingCommandCog,
         RemindMeCommandCog,
         SendGetRolesRemindersTaskCog,

cogs/induct.py

@@ -93,28 +93,33 @@
             (
                 f"**Congrats on joining the {self.bot.group_short_name} Discord server "
                 f"as a {user_type}!** "
-                "You now have access to communicate in all the public channels.\n\n"
+                "\n\n"
+            )
+        ]
+
+        if user_type == "member":
+            messages_to_send.append(
+                f"**Thank you for becomming a member of {self.bot.group_short_name}.**\n"
+                "you now have access to all public channels including the minecraft server and other member only channels.\n"
+                "and you now also have that shiny new Role"
+            )
+
+        if user_type != "member":
+            messages_to_send.append(
                 "Some things to do to get started:\n"
                 f"1. Check out our rules in {
                     await self.bot.get_mention_string(self.bot.rules_channel)
                 }\n"
-                f"2. Head to {
-                    await self.bot.get_mention_string(self.bot.roles_channel)
-                } and click on the icons to get optional roles like pronouns and year groups\n"
+                f"2. Head to Channels & Roles in the Onboarding screen and click on the icons to get optional roles like pronouns, year groups and games\n"
                 "3. Change your nickname to whatever you wish others to refer to you as "
                 "(You can do this by right-clicking your name in the members-list "
                 'to the right & selecting "Edit Server Profile").'
-            )
-        ]
-
-        if user_type != "member":
-            messages_to_send.append(
-                f"You can also get yourself an annual membership "
+                "You can also get yourself an annual membership "
                 f"to {self.bot.group_full_name} for only £5! "
                 f"Just head to {settings['PURCHASE_MEMBERSHIP_URL']}. "
-                "You'll get awesome perks like a free T-shirt:shirt:, "
-                "access to member only events:calendar_spiral: and a cool green name on "
-                f"the {self.bot.group_short_name} Discord server:green_square:! "
+                f"You'll get awesome perks like acess to the {self.bot.group_short_name} Minecraft server :pick:, "
+                "access to member only events :calendar_spiral: and a cool blue Role on "
+                f"the {self.bot.group_short_name} Discord server :blue_square:! "
                 f"Checkout all the perks at {settings['MEMBERSHIP_PERKS_URL']}"
             )
 

cogs/make_member.py

@@ -2,26 +2,31 @@
 
 import logging
 import re
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, override
 
 import discord
+from discord.ui import Modal, View
 from django.core.exceptions import ValidationError
 
 from config import settings
 from db.core.models import GroupMadeMember
 from exceptions import ApplicantRoleDoesNotExistError, GuestRoleDoesNotExistError
-from utils import CommandChecks, TeXBotBaseCog
-from utils.msl import fetch_community_group_members_count, is_id_a_community_group_member
+from utils import CommandChecks, TeXBotApplicationContext, TeXBotBaseCog
+from utils.msl import (
+    fetch_community_group_members_count,
+    is_id_a_community_group_member,
+)
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
     from logging import Logger
     from typing import Final
 
-    from utils import TeXBotApplicationContext
-
-
-__all__: "Sequence[str]" = ("MakeMemberCommandCog", "MemberCountCommandCog")
+__all__: "Sequence[str]" = (
+    "MakeMemberCommandCog",
+    "MakeMemberModalCommandCog",
+    "MemberCountCommandCog",
+)
 
 
 logger: "Final[Logger]" = logging.getLogger("TeX-Bot")
@@ -225,3 +230,136 @@ async def member_count(self, ctx: "TeXBotApplicationContext") -> None:  # type:
                     f"{await fetch_community_group_members_count()} members! :tada:"
                 )
             )
+
+
+class MakeMemberModalActual(Modal):
+    """A discord.Modal containing a the input box for make member user interaction."""
+
+    @override
+    def __init__(self) -> None:
+        super().__init__(title="Make Member Modal")
+        self.add_item(
+            discord.ui.InputText(
+                label="Student ID",
+                min_length=7,
+                max_length=7,
+                required=True,
+                placeholder="1234567",
+            )
+        )
+
+    @override
+    async def callback(self, interaction: discord.Interaction) -> None:
+        raw_student_id: str | None = self.children[0].value
+        if not raw_student_id:
+            await interaction.response.send_message(
+                content="Invalid Student ID.", ephemeral=True
+            )
+            return
+
+        try:
+            student_id: int = int(raw_student_id)
+        except ValueError:
+            await interaction.response.send_message(
+                content="Student ID must be a number.", ephemeral=True
+            )
+            return
+
+        if await is_id_a_community_group_member(member_id=student_id):
+            await MakeMemberModalCommandCog.give_member_role(
+                self=MakeMemberModalCommandCog(bot=interaction.client), interaction=interaction
+            )
+            await interaction.response.send_message(content="Action complete.", ephemeral=True)
+            return
+
+        await interaction.response.send_message(
+            content="Student ID not found.", ephemeral=True
+        )
+
+
+class OpenMemberVerifyModalView(View):
+    """A discord.View containing a button to open a new member verification modal."""
+
+    def __init__(self) -> None:
+        super().__init__(timeout=None)
+
+    @discord.ui.button(
+        label="Verify", style=discord.ButtonStyle.primary, custom_id="verify_new_member"
+    )
+    async def verify_new_member_button_callback(  # type: ignore[misc]
+        self, _: discord.Button, interaction: discord.Interaction
+    ) -> None:
+        await interaction.response.send_modal(MakeMemberModalActual())
+
+
+class MakeMemberModalCommandCog(TeXBotBaseCog):
+    """Cog class that defines the "/make-member-modal" command and its call-back method."""
+
+    @TeXBotBaseCog.listener()
+    async def on_ready(self) -> None:
+        """Add OpenMemberVerifyModalView to the bot's list of permanent views."""
+        self.bot.add_view(OpenMemberVerifyModalView())
+
+    async def give_member_role(self, interaction: discord.Interaction) -> None:
+        """Give the member role to the user who interacted with the modal."""
+        if not isinstance(interaction.user, discord.Member):
+            await self.command_send_error(
+                ctx=TeXBotApplicationContext(bot=interaction.client, interaction=interaction),
+                message="User is not a member.",
+            )
+            return
+
+        await interaction.user.add_roles(
+            await self.bot.member_role,
+            reason=f'{interaction.user} used TeX Bot modal: "Make Member"',
+        )
+        try:
+            guest_role: discord.Role = await self.bot.guest_role
+        except GuestRoleDoesNotExistError:
+            logger.warning(
+                '"/make-member" command used but the "Guest" role does not exist. '
+                'Some user\'s may now have the "Member" role without the "Guest" role. '
+                'Use the "/ensure-members-inducted" command to fix this issue.'
+            )
+        else:
+            if guest_role not in interaction.user.roles:
+                await interaction.user.add_roles(
+                    guest_role,
+                    reason=f'{interaction.user} used TeX Bot slash-command: "/make-member"',
+                )
+
+    async def _open_make_new_member_modal(
+        self,
+        button_callback_channel: discord.TextChannel | discord.DMChannel,
+    ) -> None:
+        await button_callback_channel.send(
+            content="would you like to open the make member modal",
+            view=OpenMemberVerifyModalView(),
+        )
+
+    @discord.slash_command(  # type: ignore[no-untyped-call, misc]
+        name="make-member-modal",
+        description=(
+            "prints a message with a button that allows users to open the make member modal, "
+        ),
+    )
+    @CommandChecks.check_interaction_user_has_committee_role
+    @CommandChecks.check_interaction_user_in_main_guild
+    async def make_member_modal(  # type: ignore[misc]
+        self,
+        ctx: "TeXBotApplicationContext",
+    ) -> None:
+        """
+        Definition & callback response of the "make-member-modal" command.
+
+        The "make-member-modal" command prints a message with a button that allows users
+        to open the make member modal
+        """
+        await self._open_make_new_member_modal(
+            button_callback_channel=ctx.channel,
+        )
+
+        await ctx.respond(
+            content="The make member modal has been opened in this channel.",
+            ephemeral=True,
+        )