aboutsummaryrefslogtreecommitdiffstats
path: root/botstrap.py
diff options
context:
space:
mode:
authorGravatar Boris Muratov <[email protected]>2023-04-05 00:49:48 +0300
committerGravatar Boris Muratov <[email protected]>2023-04-05 00:49:48 +0300
commitd5963661ee6f720a1b5120010856185e03d5fce7 (patch)
treef4e849563e86f337fc98b654249f972a272057f7 /botstrap.py
parentSupport custom value representation in filtering UI (diff)
parentMerge pull request #2506 from python-discord/new-helpers-end (diff)
Merge branch 'main' into new-filters
Diffstat (limited to 'botstrap.py')
-rw-r--r--botstrap.py228
1 files changed, 156 insertions, 72 deletions
diff --git a/botstrap.py b/botstrap.py
index 90a954d9b..ccf6993f5 100644
--- a/botstrap.py
+++ b/botstrap.py
@@ -1,5 +1,6 @@
import os
import re
+import sys
from pathlib import Path
from dotenv import load_dotenv
@@ -15,103 +16,165 @@ env_file_path = Path(".env.server")
BOT_TOKEN = os.getenv("BOT_TOKEN", None)
GUILD_ID = os.getenv("GUILD_ID", None)
+COMMUNITY_FEATURE = "COMMUNITY"
+PYTHON_HELP_CHANNEL_NAME = "python_help"
+PYTHON_HELP_CATEGORY_NAME = "python_help_system"
+ANNOUNCEMENTS_CHANNEL_NAME = "announcements"
+RULES_CHANNEL_NAME = "rules"
+GUILD_FORUM_TYPE = 15
if not BOT_TOKEN:
message = (
- "Couldn't find BOT_TOKEN in the environment variables."
- "Make sure to add it to the `.env` file likewise: `BOT_TOKEN=value_of_your_bot_token`"
+ "Couldn't find the `BOT_TOKEN` environment variable. "
+ "Make sure to add it to your `.env` file like this: `BOT_TOKEN=value_of_your_bot_token`"
)
log.warning(message)
raise ValueError(message)
if not GUILD_ID:
message = (
- "Couldn't find GUILD_ID in the environment variables."
- "Make sure to add it to the `.env` file likewise: `GUILD_ID=value_of_your_discord_server_id`"
+ "Couldn't find the `GUILD_ID` environment variable. "
+ "Make sure to add it to your `.env` file like this: `GUILD_ID=value_of_your_discord_server_id`"
)
log.warning(message)
raise ValueError(message)
+class SilencedDict(dict):
+ """A dictionary that silences KeyError exceptions upon subscription to non existent items."""
+
+ def __init__(self, name: str):
+ self.name = name
+ super().__init__()
+
+ def __getitem__(self, item: str):
+ try:
+ return super().__getitem__(item)
+ except KeyError:
+ log.warning(f"Couldn't find key: {item} in dict: {self.name} ")
+ log.warning(
+ "Please make sure to follow our contribution guideline "
+ "https://www.pythondiscord.com/pages/guides/pydis-guides/contributing/bot/ "
+ "to guarantee a successful run of botstrap "
+ )
+ sys.exit(-1)
+
+
class DiscordClient(Client):
"""An HTTP client to communicate with Discord's APIs."""
- def __init__(self):
+ def __init__(self, guild_id: int | str):
super().__init__(
base_url="https://discord.com/api/v10",
headers={"Authorization": f"Bot {BOT_TOKEN}"},
- event_hooks={"response": [self._raise_for_status]}
+ event_hooks={"response": [self._raise_for_status]},
)
+ self.guild_id = guild_id
@staticmethod
def _raise_for_status(response: Response) -> None:
response.raise_for_status()
-
-def get_all_roles(guild_id: int | str, client: DiscordClient) -> dict:
- """Fetches all the roles in a guild."""
- result = {}
-
- response = client.get(f"guilds/{guild_id}/roles")
- roles = response.json()
-
- for role in roles:
- name = "_".join(part.lower() for part in role["name"].split(" ")).replace("-", "_")
- result[name] = role["id"]
-
- return result
-
-
-def get_all_channels_and_categories(
- guild_id: int | str,
- client: DiscordClient
-) -> tuple[dict[str, str], dict[str, str]]:
- """Fetches all the text channels & categories in a guild."""
- off_topic_channel_name_regex = r"ot\d{1}(_.*)+"
- off_topic_count = 0
- channels = {} # could be text channels only as well
- categories = {}
-
- response = client.get(f"guilds/{guild_id}/channels")
- server_channels = response.json()
-
- for channel in server_channels:
- channel_type = channel["type"]
- name = "_".join(part.lower() for part in channel["name"].split(" ")).replace("-", "_")
- if re.match(off_topic_channel_name_regex, name):
- name = f"off_topic_{off_topic_count}"
- off_topic_count += 1
-
- if channel_type == 4:
- categories[name] = channel["id"]
- else:
- channels[name] = channel["id"]
-
- return channels, categories
-
-
-def webhook_exists(webhook_id_: int, client: DiscordClient) -> bool:
- """A predicate that indicates whether a webhook exists already or not."""
- try:
- client.get(f"webhooks/{webhook_id_}")
- return True
- except HTTPStatusError:
- return False
-
-
-def create_webhook(name: str, channel_id_: int, client: DiscordClient) -> str:
- """Creates a new webhook for a particular channel."""
- payload = {"name": name}
-
- response = client.post(f"channels/{channel_id_}/webhooks", json=payload)
- new_webhook = response.json()
- return new_webhook["id"]
-
-
-with DiscordClient() as discord_client:
+ def upgrade_server_to_community_if_necessary(
+ self,
+ rules_channel_id_: int | str,
+ announcements_channel_id_: int | str,
+ ) -> None:
+ """Fetches server info & upgrades to COMMUNITY if necessary."""
+ response = self.get(f"/guilds/{self.guild_id}")
+ payload = response.json()
+
+ if COMMUNITY_FEATURE not in payload["features"]:
+ log.warning("This server is currently not a community, upgrading.")
+ payload["features"].append(COMMUNITY_FEATURE)
+ payload["rules_channel_id"] = rules_channel_id_
+ payload["public_updates_channel_id"] = announcements_channel_id_
+ self.patch(f"/guilds/{self.guild_id}", json=payload)
+ log.info(f"Server {self.guild_id} has been successfully updated to a community.")
+
+ def create_forum_channel(
+ self,
+ channel_name_: str,
+ category_id_: int | str | None = None
+ ) -> int:
+ """Creates a new forum channel."""
+ payload = {"name": channel_name_, "type": GUILD_FORUM_TYPE}
+ if category_id_:
+ payload["parent_id"] = category_id_
+
+ response = self.post(f"/guilds/{self.guild_id}/channels", json=payload)
+ forum_channel_id = response.json()["id"]
+ log.info(f"New forum channel: {channel_name_} has been successfully created.")
+ return forum_channel_id
+
+ def is_forum_channel(self, channel_id_: str) -> bool:
+ """A boolean that indicates if a channel is of type GUILD_FORUM."""
+ response = self.get(f"/channels/{channel_id_}")
+ return response.json()["type"] == GUILD_FORUM_TYPE
+
+ def delete_channel(self, channel_id_: id) -> None:
+ """Delete a channel."""
+ log.info(f"Channel python-help: {channel_id_} is not a forum channel and will be replaced with one.")
+ self.delete(f"/channels/{channel_id_}")
+
+ def get_all_roles(self) -> dict:
+ """Fetches all the roles in a guild."""
+ result = SilencedDict(name="Roles dictionary")
+
+ response = self.get(f"guilds/{self.guild_id}/roles")
+ roles = response.json()
+
+ for role in roles:
+ name = "_".join(part.lower() for part in role["name"].split(" ")).replace("-", "_")
+ result[name] = role["id"]
+
+ return result
+
+ def get_all_channels_and_categories(self) -> tuple[dict[str, str], dict[str, str]]:
+ """Fetches all the text channels & categories in a guild."""
+ off_topic_channel_name_regex = r"ot\d{1}(_.*)+"
+ off_topic_count = 0
+ channels = SilencedDict(name="Channels dictionary")
+ categories = SilencedDict(name="Categories dictionary")
+
+ response = self.get(f"guilds/{self.guild_id}/channels")
+ server_channels = response.json()
+
+ for channel in server_channels:
+ channel_type = channel["type"]
+ name = "_".join(part.lower() for part in channel["name"].split(" ")).replace("-", "_")
+ if re.match(off_topic_channel_name_regex, name):
+ name = f"off_topic_{off_topic_count}"
+ off_topic_count += 1
+
+ if channel_type == 4:
+ categories[name] = channel["id"]
+ else:
+ channels[name] = channel["id"]
+
+ return channels, categories
+
+ def webhook_exists(self, webhook_id_: int) -> bool:
+ """A predicate that indicates whether a webhook exists already or not."""
+ try:
+ self.get(f"webhooks/{webhook_id_}")
+ return True
+ except HTTPStatusError:
+ return False
+
+ def create_webhook(self, name: str, channel_id_: int) -> str:
+ """Creates a new webhook for a particular channel."""
+ payload = {"name": name}
+
+ response = self.post(f"channels/{channel_id_}/webhooks", json=payload)
+ new_webhook = response.json()
+ return new_webhook["id"]
+
+
+with DiscordClient(guild_id=GUILD_ID) as discord_client:
config_str = "#Roles\n"
- all_roles = get_all_roles(guild_id=GUILD_ID, client=discord_client)
+ all_roles = discord_client.get_all_roles()
for role_name in _Roles.__fields__:
@@ -122,10 +185,30 @@ with DiscordClient() as discord_client:
config_str += f"roles_{role_name}={role_id}\n"
- all_channels, all_categories = get_all_channels_and_categories(guild_id=GUILD_ID, client=discord_client)
+ all_channels, all_categories = discord_client.get_all_channels_and_categories()
config_str += "\n#Channels\n"
+ rules_channel_id = all_channels[RULES_CHANNEL_NAME]
+ announcements_channel_id = all_channels[ANNOUNCEMENTS_CHANNEL_NAME]
+
+ discord_client.upgrade_server_to_community_if_necessary(rules_channel_id, announcements_channel_id)
+
+ create_help_channel = True
+
+ if PYTHON_HELP_CHANNEL_NAME in all_channels:
+ python_help_channel_id = all_channels[PYTHON_HELP_CHANNEL_NAME]
+ if not discord_client.is_forum_channel(python_help_channel_id):
+ discord_client.delete_channel(python_help_channel_id)
+ else:
+ create_help_channel = False
+
+ if create_help_channel:
+ python_help_channel_name = PYTHON_HELP_CHANNEL_NAME.replace('_', '-')
+ python_help_category_id = all_categories[PYTHON_HELP_CATEGORY_NAME]
+ python_help_channel_id = discord_client.create_forum_channel(python_help_channel_name, python_help_category_id)
+ all_channels[PYTHON_HELP_CHANNEL_NAME] = python_help_channel_id
+
for channel_name in _Channels.__fields__:
channel_id = all_channels.get(channel_name, None)
if not channel_id:
@@ -135,6 +218,7 @@ with DiscordClient() as discord_client:
continue
config_str += f"channels_{channel_name}={channel_id}\n"
+ config_str += f"channels_{PYTHON_HELP_CHANNEL_NAME}={python_help_channel_id}\n"
config_str += "\n#Categories\n"
@@ -153,10 +237,10 @@ with DiscordClient() as discord_client:
config_str += "\n#Webhooks\n"
for webhook_name, webhook_model in Webhooks:
- webhook = webhook_exists(webhook_model.id, client=discord_client)
+ webhook = discord_client.webhook_exists(webhook_model.id)
if not webhook:
webhook_channel_id = int(all_channels[webhook_name])
- webhook_id = create_webhook(webhook_name, webhook_channel_id, client=discord_client)
+ webhook_id = discord_client.create_webhook(webhook_name, webhook_channel_id)
else:
webhook_id = webhook_model.id
config_str += f"webhooks_{webhook_name}__id={webhook_id}\n"