Generate new Discord invite-link fallback if missing CUSTOM_DISCORD_INVITE_URL (#504)

Author: CarrotManMatt

.env.example

@@ -32,7 +32,7 @@ MEMBERSHIP_PERKS_URL=[Replace with your group\'s membership-perks URL]
 
 # The invite link URL to allow users to join your community group's Discord server
 # Must be a valid URL
-DISCORD_INVITE_URL=[Replace with your group\'s Discord server invite link]
+CUSTOM_DISCORD_INVITE_URL=[Replace with your group\'s Discord server invite link]
 
 
 # The minimum level that logs must meet in order to be logged to the console output stream
@@ -54,7 +54,7 @@ MEMBERS_LIST_URL_SESSION_COOKIE=[Replace with your .ASPXAUTH cookie]
 
 
 # The probability that the more rare ping command response will be sent instead of the normal one
-# Must be a float between & including 1 & 0
+# Must be a float between & including 0 to 1
 PING_COMMAND_EASTER_EGG_PROBABILITY=0.01
 
 

cogs/invite_link.py

@@ -23,10 +23,27 @@ class InviteLinkCommandCog(TeXBotBaseCog):
     )
     async def invite_link(self, ctx: "TeXBotApplicationContext") -> None:  # type: ignore[misc]
         """Definition & callback response of the "invite-link" command."""
+        discord_invite_url: str | None = settings["CUSTOM_DISCORD_INVITE_URL"]
+
+        if not discord_invite_url:
+            invite_destination_channel: discord.TextChannel | None = discord.utils.get(
+                ctx.bot.main_guild.text_channels, name="welcome"
+            )
+
+            if invite_destination_channel is None:
+                invite_destination_channel = await ctx.bot.rules_channel
+
+            discord_invite_url = (
+                await invite_destination_channel.create_invite(
+                    reason=f'{ctx.user} used TeX Bot slash-command: "/invite-link"',
+                    max_age=21600,
+                )
+            ).url
+
         await ctx.respond(
             (
                 f"Invite your friends to the {self.bot.group_short_name} Discord server: "
-                f"{settings['DISCORD_INVITE_URL']}"
+                f"{discord_invite_url}"
             ),
             ephemeral=False,
         )

cogs/make_member.py

@@ -226,7 +226,7 @@ async def make_member(self, ctx: "TeXBotApplicationContext", group_member_id: st
             # NOTE: The "Member" role must be added to the user **before** the "Guest" role to ensure that the welcome message does not include the suggestion to purchase membership
             await interaction_member.add_roles(
                 member_role,
-                reason='TeX Bot slash-command: "/makemember"',
+                reason=f'{ctx.user} used TeX Bot slash-command: "/makemember"',
             )
 
             try:
@@ -258,7 +258,7 @@ async def make_member(self, ctx: "TeXBotApplicationContext", group_member_id: st
                 if guest_role not in interaction_member.roles:
                     await interaction_member.add_roles(
                         guest_role,
-                        reason='TeX Bot slash-command: "/makemember"',
+                        reason=f'{ctx.user} used TeX Bot slash-command: "/makemember"',
                     )
             applicant_role: discord.Role | None
             try:
@@ -269,7 +269,7 @@ async def make_member(self, ctx: "TeXBotApplicationContext", group_member_id: st
             if applicant_role and applicant_role in interaction_member.roles:
                 await interaction_member.remove_roles(
                     applicant_role,
-                    reason='TeX Bot slash-command: "/makemember"',
+                    reason=f'{ctx.user} used TeX Bot slash-command: "/makemember"',
                 )
 
 

config.py

@@ -233,11 +233,14 @@ def _setup_discord_guild_id(cls) -> None:
     def _setup_group_full_name(cls) -> None:
         raw_group_full_name: str | None = os.getenv("GROUP_NAME")
 
-        GROUP_FULL_NAME_IS_VALID: Final[bool] = bool(
-            not raw_group_full_name
-            or re.fullmatch(r"\A[A-Za-z0-9 '&!?:,.#%\"-]+\Z", raw_group_full_name),
-        )
-        if not GROUP_FULL_NAME_IS_VALID:
+        if raw_group_full_name is not None:
+            raw_group_full_name = raw_group_full_name.strip()
+
+        if not raw_group_full_name:
+            cls._settings["_GROUP_FULL_NAME"] = None
+            return
+
+        if not re.fullmatch(r"\A[A-Za-z0-9 '&!?:,.#%\"-]+\Z", raw_group_full_name):
             INVALID_GROUP_FULL_NAME: Final[str] = (
                 "GROUP_NAME must not contain any invalid characters."
             )
@@ -249,11 +252,14 @@ def _setup_group_full_name(cls) -> None:
     def _setup_group_short_name(cls) -> None:
         raw_group_short_name: str | None = os.getenv("GROUP_SHORT_NAME")
 
-        GROUP_SHORT_NAME_IS_VALID: Final[bool] = bool(
-            not raw_group_short_name
-            or re.fullmatch(r"\A[A-Za-z0-9'&!?:,.#%\"-]+\Z", raw_group_short_name),
-        )
-        if not GROUP_SHORT_NAME_IS_VALID:
+        if raw_group_short_name is not None:
+            raw_group_short_name = raw_group_short_name.strip()
+
+        if not raw_group_short_name:
+            cls._settings["_GROUP_SHORT_NAME"] = None
+            return
+
+        if not re.fullmatch(r"\A[A-Za-z0-9'&!?:,.#%\"-]+\Z", raw_group_short_name):
             INVALID_GROUP_SHORT_NAME: Final[str] = (
                 "GROUP_SHORT_NAME must not contain any invalid characters."
             )
@@ -265,10 +271,14 @@ def _setup_group_short_name(cls) -> None:
     def _setup_purchase_membership_url(cls) -> None:
         raw_purchase_membership_url: str | None = os.getenv("PURCHASE_MEMBERSHIP_URL")
 
-        PURCHASE_MEMBERSHIP_URL_IS_VALID: Final[bool] = bool(
-            not raw_purchase_membership_url or validators.url(raw_purchase_membership_url),
-        )
-        if not PURCHASE_MEMBERSHIP_URL_IS_VALID:
+        if raw_purchase_membership_url is not None:
+            raw_purchase_membership_url = raw_purchase_membership_url.strip()
+
+        if not raw_purchase_membership_url:
+            cls._settings["PURCHASE_MEMBERSHIP_URL"] = None
+            return
+
+        if not validators.url(raw_purchase_membership_url):
             INVALID_PURCHASE_MEMBERSHIP_URL_MESSAGE: Final[str] = (
                 "PURCHASE_MEMBERSHIP_URL must be a valid URL."
             )
@@ -280,10 +290,14 @@ def _setup_purchase_membership_url(cls) -> None:
     def _setup_membership_perks_url(cls) -> None:
         raw_membership_perks_url: str | None = os.getenv("MEMBERSHIP_PERKS_URL")
 
-        MEMBERSHIP_PERKS_URL_IS_VALID: Final[bool] = bool(
-            not raw_membership_perks_url or validators.url(raw_membership_perks_url),
-        )
-        if not MEMBERSHIP_PERKS_URL_IS_VALID:
+        if raw_membership_perks_url is not None:
+            raw_membership_perks_url = raw_membership_perks_url.strip()
+
+        if not raw_membership_perks_url:
+            cls._settings["MEMBERSHIP_PERKS_URL"] = None
+            return
+
+        if not validators.url(raw_membership_perks_url):
             INVALID_MEMBERSHIP_PERKS_URL_MESSAGE: Final[str] = (
                 "MEMBERSHIP_PERKS_URL must be a valid URL."
             )
@@ -292,30 +306,47 @@ def _setup_membership_perks_url(cls) -> None:
         cls._settings["MEMBERSHIP_PERKS_URL"] = raw_membership_perks_url
 
     @classmethod
-    def _setup_discord_invite_url(cls) -> None:
-        raw_discord_invite_url: str | None = os.getenv("DISCORD_INVITE_URL")
+    def _setup_custom_discord_invite_url(cls) -> None:
+        raw_custom_discord_invite_url: str | None = os.getenv("CUSTOM_DISCORD_INVITE_URL")
 
-        DISCORD_INVITE_URL_IS_VALID: Final[bool] = bool(
-            not raw_discord_invite_url or validators.url(raw_discord_invite_url),
-        )
-        if not DISCORD_INVITE_URL_IS_VALID:
-            INVALID_DISCORD_INVITE_URL_MESSAGE: Final[str] = (
-                "DISCORD_INVITE_URL must be a valid URL."
+        if raw_custom_discord_invite_url is not None:
+            raw_custom_discord_invite_url = raw_custom_discord_invite_url.strip()
+
+        if not raw_custom_discord_invite_url:
+            cls._settings["CUSTOM_DISCORD_INVITE_URL"] = None
+            return
+
+        if not validators.url(raw_custom_discord_invite_url):
+            INVALID_CUSTOM_DISCORD_INVITE_URL_MESSAGE: Final[str] = (
+                "CUSTOM_DISCORD_INVITE_URL must be a valid URL."
             )
-            raise ImproperlyConfiguredError(INVALID_DISCORD_INVITE_URL_MESSAGE)
+            raise ImproperlyConfiguredError(INVALID_CUSTOM_DISCORD_INVITE_URL_MESSAGE)
 
-        cls._settings["DISCORD_INVITE_URL"] = raw_discord_invite_url
+        cls._settings["CUSTOM_DISCORD_INVITE_URL"] = raw_custom_discord_invite_url
 
     @classmethod
     def _setup_ping_command_easter_egg_probability(cls) -> None:
+        raw_ping_command_easter_egg_probability_string: str | None = os.getenv(
+            "PING_COMMAND_EASTER_EGG_PROBABILITY"
+        )
+
+        if raw_ping_command_easter_egg_probability_string is not None:
+            raw_ping_command_easter_egg_probability_string = (
+                raw_ping_command_easter_egg_probability_string.strip()
+            )
+
+        if not raw_ping_command_easter_egg_probability_string:
+            cls._settings["PING_COMMAND_EASTER_EGG_PROBABILITY"] = 1
+            return
+
         INVALID_PING_COMMAND_EASTER_EGG_PROBABILITY_MESSAGE: Final[str] = (
-            "PING_COMMAND_EASTER_EGG_PROBABILITY must be a float between & including 1 & 0."
+            "PING_COMMAND_EASTER_EGG_PROBABILITY must be a float between & including 0 to 1."
         )
 
         e: ValueError
         try:
             raw_ping_command_easter_egg_probability: float = 100 * float(
-                os.getenv("PING_COMMAND_EASTER_EGG_PROBABILITY", "0.01"),
+                raw_ping_command_easter_egg_probability_string
             )
         except ValueError as e:
             raise (
@@ -324,7 +355,7 @@ def _setup_ping_command_easter_egg_probability(cls) -> None:
 
         if not 0 <= raw_ping_command_easter_egg_probability <= 100:
             raise ImproperlyConfiguredError(
-                INVALID_PING_COMMAND_EASTER_EGG_PROBABILITY_MESSAGE,
+                INVALID_PING_COMMAND_EASTER_EGG_PROBABILITY_MESSAGE
             )
 
         cls._settings["PING_COMMAND_EASTER_EGG_PROBABILITY"] = (
@@ -753,7 +784,7 @@ def _setup_env_variables(cls) -> None:
             cls._setup_members_list_auth_session_cookie()
             cls._setup_membership_perks_url()
             cls._setup_purchase_membership_url()
-            cls._setup_discord_invite_url()
+            cls._setup_custom_discord_invite_url()
             cls._setup_send_introduction_reminders()
             cls._setup_send_introduction_reminders_delay()
             cls._setup_send_introduction_reminders_interval()

utils/tex_bot.py

@@ -196,7 +196,7 @@ async def archivist_role(self) -> discord.Role:
         """
         Shortcut accessor to the archivist role.
 
-        The archivist role is the one that allows members to see channels & categories
+        The archivist role is the one that allows members to see channels and categories
         that are no longer in use, which are hidden from all other members.
 
         Raises `ArchivistRoleDoesNotExist` if the role does not exist.
@@ -268,7 +268,7 @@ async def rules_channel(self) -> discord.TextChannel:
         """
         Shortcut accessor to the rules text channel.
 
-        The rules text channel is the one that contains the welcome message & rules.
+        The rules text channel is the one that contains the welcome message and rules.
 
         Raises `RulesChannelDoesNotExist` if the channel does not exist.
         """