Merge pull request #180 from practical-python-org/merge/cleanup-branch-additions

fix: cleanup branch additions

Author: Xarlos89

README.md

@@ -81,7 +81,8 @@ Main and Development already exist. You would want to make a new branch for what
 
 
 
-![Untitled Diagram.drawio.png](..%2F..%2FDesktop%2FUntitled%20Diagram.drawio.png)
+![git-flow](https://github.com/practical-python-org/ZorakBot/assets/33434582/9d04d6a1-305f-48d9-8cee-be3ad08e099f)
+
 
 
 ### Version Bumping through PR titles
@@ -97,4 +98,4 @@ If your PR title does not include any of the specified prefixes, the GitHub Acti
 
 When your PR is merged into main, the GitHub Action will increment the version according to the prefix in the PR title and create a new tag.
 
-Please ensure you follow this convention to maintain a well-structured and meaningful version history for our project.
+Please ensure you follow this convention to maintain a well-structured and meaningful version history for our project.

git-flow.png

@@ -84,7 +84,7 @@ def check_for_admin_override(arg_message):
             if not message.content.startswith('z.invite '):
                 return False
 
-            return any(role.id in admin_roles.values() for role in message.author.roles)
+            return any(role.id in self.bot.server_settings.admin_roles.values() for role in message.author.roles)
 
         if is_invite(txt):
             if not check_for_admin_override(txt):

src/zorak/cogs/admin/moderation_invites.py

@@ -2,10 +2,12 @@
 This is a handler that adds a Need Approval role and sends the user a message.
 """
 from asyncio import sleep
-
+import logging
 import discord
 from discord.ext import commands
 
+logger = logging.getLogger(__name__)
+
 
 class LoggingVerification(commands.Cog):
     """
@@ -24,7 +26,8 @@ async def on_member_join(self, member: discord.Member):
         await member.add_roles(member.guild.get_role(self.bot.server_settings.unverified_role["needs_approval"]))
 
         # Log unverified join
-        logs_channel = await self.bot.fetch_channel(self.bot.server_settings.log_channel["verification_log"])  # ADMIN user log
+        logs_channel = await self.bot.fetch_channel(
+            self.bot.server_settings.log_channel["verification_log"])  # ADMIN user log
         await logs_channel.send(f"<@{member.id}> joined, but has not verified.")
 
         # Send Welcome
@@ -42,7 +45,11 @@ async def on_member_join(self, member: discord.Member):
 After you do, all of {guild.name} is availibe to you. Have a great time :-)
 """
         # Send Welcome Message
-        await member.send(welcome_message)
+        try:
+            await member.send(welcome_message)
+        except discord.errors.Forbidden as catch_dat_forbidden:
+            logger.debug(f'{member.name} cannot be sent a DM.')
+
         time_unverified_kick = 3600  # 1 hour
         await sleep(time_unverified_kick)
 
@@ -54,7 +61,8 @@ async def on_member_join(self, member: discord.Member):
 
             if "Needs Approval" in [role.name for role in member.roles]:
                 # Log the kick
-                await logs_channel.send(f"{member.mention} did not verify, auto-removed." f" ({(time_unverified_kick/3600)} hour/s)")
+                await logs_channel.send(
+                    f"{member.mention} did not verify, auto-removed." f" ({(time_unverified_kick / 3600)} hour/s)")
                 await member.kick(reason="Did not verify.")
 
 

src/zorak/cogs/admin/verification_on_join.py

@@ -23,19 +23,23 @@ async def verify_button_callback(self, bot, interaction):
         user = interaction.user
         guild = interaction.guild
         roles = guild.roles
-        role = discord.utils.get(roles, id=user_roles["unverified"]["needs_approval"])
+        unverified_role = discord.utils.get(roles, id=self.bot.server_settings.unverified_role['needs_approval'])
+
+        # Moved this up here, as someone "unverified" might be able to block the command.
+        if "Needs Approval" not in [role.name for role in user.roles]:
+            await user.send("You have already been Verified. Go away.")
 
         website = "https://practical-python-org.github.io/Home/"
-        website_emoji = discord.utils.get(self.bot.emojis, name="logo")
+        website_emoji = ":globe_with_meridians:"
         email = "[email protected]"
-        email_emoji = "<:email:1040342884240597122>"
+        email_emoji = ":email:"
         review = "https://disboard.org/review/create/900302240559018015"
         review_emoji = "<:100:1040342353417863318>"
         created = str(guild.created_at.timestamp())
         created = created[:10]
         created_emoji = "<:triangular_flag_on_post:1040343017204228217>"
         owner = guild.owner.mention
-        owner_emoji = discord.utils.get(self.bot.emojis, name="xarlos")
+        owner_emoji = (":crown:")
         invite = "https://discord.gg/vgZmgNwuHw"
         invite_emoji = "<:heart_hands:1040343137454915594>"
 
@@ -70,14 +74,13 @@ async def verify_button_callback(self, bot, interaction):
         embed.add_field(name="Information", value=info)
 
         if "Needs Approval" in [role.name for role in user.roles]:
-            await user.remove_roles(role)
+            await user.remove_roles(unverified_role)
             await user.send(embed=embed)
 
             log_channels = await self.bot.fetch_channel(self.bot.server_settings.log_channel["verification_log"])  # ADMIN user log
             await log_channels.send(f"{user.mention} has verified!")
 
-        else:
-            await user.send("You have already been Verified. Go away.")
+
 
 
 class VerifyHelper(commands.Cog):

src/zorak/cogs/admin/verification_on_verified.py

@@ -6,7 +6,7 @@
 import discord
 from discord.ext import commands
 
-# from utilities.cog_helpers._embeds import  embed_message_delete
+from zorak.utilities.cog_helpers._embeds import embed_message_delete
 
 
 class LoggingMessageDelete(commands.Cog):
@@ -21,52 +21,30 @@ def __init__(self, bot):
     @commands.Cog.listener()
     async def on_message_delete(self, message):
         """
-        then we grab the guild, and from there read the last entry in the audit log.
-        Discord is stupid right now, and message deletes in the audit log suck,
-        so we cant use this now.
-        https://discordpy.readthedocs.io/en/stable/api.html
-        ?highlight=audit%20log#discord.AuditLogAction.message_delete
+        If a mod deletes, take the audit log event. If a user deletes, handle it normally.
         """
-        # current_guild = self.bot.get_guild(server_info['id'])
-        # audit_log = [entry async for entry in current_guild.audit_logs(limit=1)][0]
-        #
-        # if str(audit_log.action) == 'AuditLogAction.message_delete':
-        #     member = current_guild.get_member(audit_log.user.id)
-        #
-        #     embed = embed_message_delete(member, audit_log.target, message)
-        #
-        #     logs_channel = await self.bot.fetch_channel(log_channel["chat_log"])
-        #     await logs_channel.send(embed=embed)
-        #     return
-
-        if message.author.nick is None:
-            username = message.author
-        else:
-            username = message.author.nick
-
-        author = message.author
+        current_guild = self.bot.get_guild(self.bot.server_settings.server_info['id'])
+        audit_log = [entry async for entry in current_guild.audit_logs(limit=1)][0]
+        logs_channel = await self.bot.fetch_channel(self.bot.server_settings.log_channel["chat_log"])
 
-        embed = discord.Embed(
-            title="<:red_circle:1043616578744357085> Deleted Message",
-            description=f"Deleted by {username}\nIn {message.channel.mention}",
-            color=discord.Color.dark_red(),
-            timestamp=datetime.utcnow(),
-        )
-        embed.set_thumbnail(url=author.avatar)
+        # If the audit log is triggered, it means someone OTHER than the author deleted the message.
+        # https://discordpy.readthedocs.io/en/stable/api.html
+        # ?highlight=audit%20log#discord.AuditLogAction.message_delete
+        if str(audit_log.action) == 'AuditLogAction.message_delete':
+            embed = embed_message_delete(audit_log.user, message)
+            await logs_channel.send(embed=embed)
 
-        embed.add_field(
-            name="Message: ",
-            value=message.content,  # ToDo: This throws an error when deleting an embed.
-            inline=True,
-        )
+            return
+        else:
+            # Otherwise, the author deleted it.
+            username = message.author
 
-        logs_channel = await self.bot.fetch_channel(self.bot.server_settings.log_channel["chat_log"])
+            for role in message.author.roles:
+                if role.id in self.bot.server_settings.admin_roles.values():
+                    await logs_channel.send(embed=embed_message_delete(username, message))
+                    return
 
-        for role in message.author.roles:
-            if role.id in self.bot.server_settings.admin_roles.values():
-                await logs_channel.send(embed=embed)
-                return
-        await logs_channel.send(f"{username.mention}", embed=embed)
+            await logs_channel.send(f"{username.mention}", embed=embed_message_delete(username, message))
 
 
 def setup(bot):

src/zorak/cogs/logging/logging_message_delete.py

@@ -1,5 +1,7 @@
 """
 Grabs info from an RSS feed, and posts it in the server. TODO Clean
+
+this cog is retired, and not loaded by the bot. If we want to add the features again, we can.
 """
 from asyncio import sleep
 

src/zorak/cogs/utility/event_challenges.py renamed to src/zorak/cogs/utility/_event_challenges.py

@@ -136,10 +136,11 @@ def is_staff(member_obj):
         top10_no_staff = []
         points = self.bot.db_client.get_top_10()
         guild = self.bot.get_guild(self.bot.server_settings.server_info['id'])
-        for person in points:
-            member = guild.get_member(person['UserID'])
-            if not is_staff(member):
-                top10_no_staff.append((member, person['Points']))
+        for iteration, person in enumerate(points):
+            if iteration < 11:
+                member = guild.get_member(person['UserID'])
+                if not is_staff(member):
+                    top10_no_staff.append((member, person['Points']))
 
         embed = embed_leaderboard(top10_no_staff, self.bot.server_settings.server_info['name'], self.bot.server_settings.server_info['logo'])
         await ctx.respond(embed=embed)

src/zorak/cogs/utility/rss.py renamed to src/zorak/cogs/utility/_rss.py

@@ -27,7 +27,10 @@ async def on_message(self, message):
                 sourcechannel = sourceserver.get_channel(int(link[5]))
                 sourcemessage = await sourcechannel.fetch_message(int(link[6]))
 
-                if len(sourcemessage.content) <= 1000:
+                if len(sourcemessage.content) == 0:
+                    return
+
+                elif 0 < len(sourcemessage.content) <= 1000:
                     embed = discord.Embed(
                         title="Link preview: ",
                         description=f"Length: {len(sourcemessage.content)}",

src/zorak/cogs/utility/points.py

@@ -18,7 +18,6 @@ def __init__(self, bot):
     @commands.command()
     async def run(self, ctx, *, codeblock):
         """
-        # TODO: put this in it's own cog.
         Uses Piston-API to run code in the server.
         """
         logger.info("%s used the %s command."

src/zorak/cogs/utility/utility_preview_message.py

@@ -77,21 +77,21 @@ def embed_leave(some_member):
     return embed
 
 
-def embed_message_delete(some_member, some_author, some_message):
+def embed_message_delete(some_member, some_message):
     """
     Embedding for user message deletion alerts.
     """
     embed = discord.Embed(
         title='<:red_circle:1043616578744357085> Deleted Message'
-        , description=f'{some_author} deleted a message'
+        , description=f'{some_member} deleted a message'
                       f'\nIn {some_message.channel}\nMessage '
                       f'author: {some_message.author}'
         , color=discord.Color.dark_red()
         , timestamp=datetime.utcnow()
     )
 
     embed.set_thumbnail(
-        url=some_member.avatar
+        url=some_member.avatar # the person who DELETED the message
     )
     if len(some_message.content) > 1020:
         the_message = some_message.content[0:1020] + '...'