-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
151 additions
and
148 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,163 +1,21 @@ | ||
| import os | ||
| import sys | ||
| import logging | ||
| import textwrap | ||
| from typing import Tuple, AsyncGenerator | ||
|
|
||
| import discord # type: ignore[import] | ||
| import discord.utils # type: ignore[import] | ||
| from discord import Intents | ||
| from dotenv import load_dotenv | ||
|
|
||
| from src.bot import BotClient | ||
|
|
||
| logger = logging.getLogger('srbot') | ||
| logger.setLevel(logging.INFO) | ||
| handler = logging.StreamHandler(sys.stdout) | ||
| handler.setLevel(logging.INFO) | ||
| logger.addHandler(handler) | ||
|
|
||
| intents = discord.Intents.default() | ||
| intents = Intents.default() | ||
| intents.members = True # Listen to member joins | ||
|
|
||
| client = discord.Client(intents=intents) | ||
|
|
||
| # name of the category for new welcome channels to go. | ||
| WELCOME_CATEGORY_NAME = "welcome" | ||
|
|
||
| # Name of the channel to announce welcome messages to. | ||
| ANNOUNCE_CHANNEL_NAME = "say-hello" | ||
|
|
||
| # prefix used to identify the channels to listen to passwords in. | ||
| CHANNEL_PREFIX = "welcome-" | ||
|
|
||
| # prefix of the role to give the user once the password succeeds | ||
| ROLE_PREFIX = "team-" | ||
|
|
||
| # role to give user if they have correctly entered *any* password | ||
| VERIFIED_ROLE = "verified" | ||
|
|
||
| SPECIAL_TEAM = "SRZ" | ||
| SPECIAL_ROLE = "unverified-volunteer" | ||
|
|
||
| PASSWORDS_CHANNEL_NAME = "role-passwords" | ||
|
|
||
|
|
||
| @client.event | ||
| async def on_ready() -> None: | ||
| logger.info(f"{client.user} has connected to Discord!") | ||
|
|
||
|
|
||
| @client.event | ||
| async def on_member_join(member: discord.Member) -> None: | ||
| name = member.display_name | ||
| logger.info(f"Member {name} joined") | ||
| guild: discord.Guild = member.guild | ||
| join_channel_category = discord.utils.get(guild.categories, name=WELCOME_CATEGORY_NAME) | ||
| # Create a new channel with that user able to write | ||
| channel: discord.TextChannel = await guild.create_text_channel( | ||
| f'{CHANNEL_PREFIX}{name}', | ||
| category=join_channel_category, | ||
| reason="User joined server, creating welcome channel.", | ||
| overwrites={ | ||
| guild.default_role: discord.PermissionOverwrite( | ||
| read_messages=False, | ||
| send_messages=False), | ||
| member: discord.PermissionOverwrite(read_messages=True, send_messages=True), | ||
| guild.me: discord.PermissionOverwrite(read_messages=True, send_messages=True), | ||
| }, | ||
| ) | ||
| await channel.send(textwrap.dedent( | ||
| f"""Welcome {member.mention}! | ||
| To gain access, you must send a message in this channel with the password for your group. | ||
| *Don't have the password? it should have been sent with this join link to your team leader* | ||
| """, | ||
| )) | ||
| logger.info(f"Created welcome channel for '{name}'") | ||
|
|
||
|
|
||
| @client.event | ||
| async def on_member_remove(member: discord.Member) -> None: | ||
| name = member.display_name | ||
| logger.info(f"Member '{name}' left") | ||
| join_channel_category: discord.CategoryChannel = discord.utils.get( | ||
| member.guild.categories, | ||
| name=WELCOME_CATEGORY_NAME, | ||
| ) | ||
| channel: discord.TextChannel | ||
| for channel in join_channel_category.channels: | ||
| # If the only user able to see it is the bot, then delete it. | ||
| if channel.overwrites.keys() == {member.guild.me}: | ||
| await channel.delete() | ||
| logger.info(f"Deleted channel '{channel.name}', because it has no users.") | ||
|
|
||
|
|
||
| @client.event | ||
| async def on_message(message: discord.Message) -> None: | ||
| channel: discord.TextChannel = message.channel | ||
| if not channel.name.startswith(CHANNEL_PREFIX): | ||
| return | ||
|
|
||
| chosen_team = "" | ||
| async for team_name, password in load_passwords(message.guild): | ||
| if password in message.content.lower(): | ||
| logger.info( | ||
| f"'{message.author.name}' entered the correct password for {team_name}", | ||
| ) | ||
| # Password was correct! | ||
| chosen_team = team_name | ||
|
|
||
| if chosen_team: | ||
| if chosen_team == SPECIAL_TEAM: | ||
| role_name = SPECIAL_ROLE | ||
| else: | ||
| # Add them to the 'verified' role. | ||
| # This doesn't happen in special cases because we expect a second | ||
| # step (outside of this bot) before verifying them. | ||
| role: discord.Role = discord.utils.get(message.guild.roles, name=VERIFIED_ROLE) | ||
| await message.author.add_roles(role, reason="A correct password was entered.") | ||
|
|
||
| role_name = f"{ROLE_PREFIX}{chosen_team}" | ||
|
|
||
| # Add them to that specific role | ||
| specific_role = discord.utils.get(message.guild.roles, name=role_name) | ||
| await message.author.add_roles( | ||
| specific_role, | ||
| reason="Correct password for this role was entered.", | ||
| ) | ||
| logger.info(f"gave user '{message.author.name}' the {role_name} role.") | ||
|
|
||
| if chosen_team != SPECIAL_TEAM: | ||
| announce_channel: discord.TextChannel = discord.utils.get( | ||
| message.guild.channels, | ||
| name=ANNOUNCE_CHANNEL_NAME, | ||
| ) | ||
| await announce_channel.send( | ||
| f"Welcome {message.author.mention} from team {chosen_team}", | ||
| ) | ||
| logger.info(f"Sent welcome announcement for '{message.author.name}'") | ||
|
|
||
| await channel.delete() | ||
| logger.info(f"deleted channel '{channel.name}' because verification has completed.") | ||
|
|
||
|
|
||
| async def load_passwords(guild: discord.Guild) -> AsyncGenerator[Tuple[str, str], None]: | ||
| """ | ||
| Returns a mapping from role name to the password for that role. | ||
| Reads from the first message of the channel named {PASSWORDS_CHANNEL_NAME}. | ||
| The format should be as follows: | ||
| ``` | ||
| teamname:password | ||
| ``` | ||
| """ | ||
| channel: discord.TextChannel = discord.utils.get( | ||
| guild.channels, | ||
| name=PASSWORDS_CHANNEL_NAME, | ||
| ) | ||
| message: discord.Message | ||
| async for message in channel.history(limit=100, oldest_first=True): | ||
| content: str = message.content.replace('`', '').strip() | ||
| team, password = content.split(':') | ||
| yield team.strip(), password.strip() | ||
|
|
||
| load_dotenv() | ||
| client.run(os.getenv('DISCORD_TOKEN')) | ||
| bot = BotClient(logger=logger, intents=intents) | ||
| bot.run(os.getenv('DISCORD_TOKEN')) |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| import textwrap | ||
|
|
||
| import discord | ||
| import logging | ||
|
|
||
| from .constants import * | ||
| from typing import Tuple, AsyncGenerator | ||
|
|
||
|
|
||
| class BotClient(discord.Client): | ||
| logger: logging.Logger | ||
|
|
||
| def __init__(self, logger: logging.Logger, *, loop=None, **options): | ||
| super().__init__(loop=loop, **options) | ||
| self.logger = logger | ||
|
|
||
| async def on_ready(self) -> None: | ||
| self.logger.info(f"{self.user} has connected to Discord!") | ||
|
|
||
| async def on_member_join(self, member: discord.Member) -> None: | ||
| name = member.display_name | ||
| self.logger.info(f"Member {name} joined") | ||
| guild: discord.Guild = member.guild | ||
| join_channel_category = discord.utils.get(guild.categories, name=WELCOME_CATEGORY_NAME) | ||
| # Create a new channel with that user able to write | ||
| channel: discord.TextChannel = await guild.create_text_channel( | ||
| f'{CHANNEL_PREFIX}{name}', | ||
| category=join_channel_category, | ||
| reason="User joined server, creating welcome channel.", | ||
| overwrites={ | ||
| guild.default_role: discord.PermissionOverwrite( | ||
| read_messages=False, | ||
| send_messages=False), | ||
| member: discord.PermissionOverwrite(read_messages=True, send_messages=True), | ||
| guild.me: discord.PermissionOverwrite(read_messages=True, send_messages=True), | ||
| }, | ||
| ) | ||
| await channel.send(textwrap.dedent( | ||
| f"""Welcome {member.mention}! | ||
| To gain access, you must send a message in this channel with the password for your group. | ||
| *Don't have the password? it should have been sent with this join link to your team leader* | ||
| """, | ||
| )) | ||
| self.logger.info(f"Created welcome channel for '{name}'") | ||
|
|
||
| async def on_member_remove(self, member: discord.Member) -> None: | ||
| name = member.display_name | ||
| self.logger.info(f"Member '{name}' left") | ||
| join_channel_category: discord.CategoryChannel = discord.utils.get( | ||
| member.guild.categories, | ||
| name=WELCOME_CATEGORY_NAME, | ||
| ) | ||
| channel: discord.TextChannel | ||
| for channel in join_channel_category.channels: | ||
| # If the only user able to see it is the bot, then delete it. | ||
| if channel.overwrites.keys() == {member.guild.me}: | ||
| await channel.delete() | ||
| self.logger.info(f"Deleted channel '{channel.name}', because it has no users.") | ||
|
|
||
| async def on_message(self, message: discord.Message) -> None: | ||
| channel: discord.TextChannel = message.channel | ||
| if not channel.name.startswith(CHANNEL_PREFIX): | ||
| return | ||
|
|
||
| chosen_team = "" | ||
| async for team_name, password in self.load_passwords(message.guild): | ||
| if password in message.content.lower(): | ||
| self.logger.info( | ||
| f"'{message.author.name}' entered the correct password for {team_name}", | ||
| ) | ||
| # Password was correct! | ||
| chosen_team = team_name | ||
|
|
||
| if chosen_team: | ||
| if chosen_team == SPECIAL_TEAM: | ||
| role_name = SPECIAL_ROLE | ||
| else: | ||
| # Add them to the 'verified' role. | ||
| # This doesn't happen in special cases because we expect a second | ||
| # step (outside of this bot) before verifying them. | ||
| role: discord.Role = discord.utils.get(message.guild.roles, name=VERIFIED_ROLE) | ||
| await message.author.add_roles(role, reason="A correct password was entered.") | ||
|
|
||
| role_name = f"{ROLE_PREFIX}{chosen_team}" | ||
|
|
||
| # Add them to that specific role | ||
| specific_role = discord.utils.get(message.guild.roles, name=role_name) | ||
| await message.author.add_roles( | ||
| specific_role, | ||
| reason="Correct password for this role was entered.", | ||
| ) | ||
| self.logger.info(f"gave user '{message.author.name}' the {role_name} role.") | ||
|
|
||
| if chosen_team != SPECIAL_TEAM: | ||
| announce_channel: discord.TextChannel = discord.utils.get( | ||
| message.guild.channels, | ||
| name=ANNOUNCE_CHANNEL_NAME, | ||
| ) | ||
| await announce_channel.send( | ||
| f"Welcome {message.author.mention} from team {chosen_team}", | ||
| ) | ||
| self.logger.info(f"Sent welcome announcement for '{message.author.name}'") | ||
|
|
||
| await channel.delete() | ||
| self.logger.info(f"deleted channel '{channel.name}' because verification has completed.") | ||
|
|
||
| async def load_passwords(self, guild: discord.Guild) -> AsyncGenerator[Tuple[str, str], None]: | ||
| """ | ||
| Returns a mapping from role name to the password for that role. | ||
| Reads from the first message of the channel named {PASSWORDS_CHANNEL_NAME}. | ||
| The format should be as follows: | ||
| ``` | ||
| teamname:password | ||
| ``` | ||
| """ | ||
| channel: discord.TextChannel = discord.utils.get( | ||
| guild.channels, | ||
| name=PASSWORDS_CHANNEL_NAME, | ||
| ) | ||
| message: discord.Message | ||
| async for message in channel.history(limit=100, oldest_first=True): | ||
| content: str = message.content.replace('`', '').strip() | ||
| team, password = content.split(':') | ||
| yield team.strip(), password.strip() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # name of the category for new welcome channels to go. | ||
| WELCOME_CATEGORY_NAME = "welcome" | ||
|
|
||
| # Name of the channel to announce welcome messages to. | ||
| ANNOUNCE_CHANNEL_NAME = "say-hello" | ||
|
|
||
| # prefix used to identify the channels to listen to passwords in. | ||
| CHANNEL_PREFIX = "welcome-" | ||
|
|
||
| # prefix of the role to give the user once the password succeeds | ||
| ROLE_PREFIX = "team-" | ||
|
|
||
| # role to give user if they have correctly entered *any* password | ||
| VERIFIED_ROLE = "verified" | ||
|
|
||
| SPECIAL_TEAM = "SRZ" | ||
| SPECIAL_ROLE = "unverified-volunteer" | ||
|
|
||
| PASSWORDS_CHANNEL_NAME = "role-passwords" |