Template v5.1

kkrypt0nn · kkrypt0nn · commit 70890d6981a3 · 2022-09-12T19:15:06.000+02:00
* Added the `help` command once again
* Created a group for the `warning` command, has following sub-commands:
  * `add` - Adds a warning to the user
  * `remove` - Removes a warning from the user
  * `list` - Lists all the warnings of the user
diff --git a/UPDATES.md b/UPDATES.md
@@ -2,6 +2,14 @@
 
 Here is the list of all the updates that I made on this template.
 
+### Version 5.1 (12 September 2022)
+
+* Added the `help` command once again
+* Created a group for the `warning` command, has following sub-commands:
+  * `add` - Adds a warning to the user
+  * `remove` - Removes a warning from the user
+  * `list` - Lists all the warnings of the user
+
 ### Version 5.0 (20 August 2022)
 
 > ⚠️ **Moved to discord.py 2.0 as it is now officially released**
diff --git a/bot.py b/bot.py
@@ -3,7 +3,7 @@
 Description:
 This is a template to create your own discord bot in python.
 
-Version: 5.0
+Version: 5.1
 """
 
 import asyncio
diff --git a/cogs/fun.py b/cogs/fun.py
@@ -3,7 +3,7 @@
 Description:
 This is a template to create your own discord bot in python.
 
-Version: 5.0
+Version: 5.1
 """
 
 import random
diff --git a/cogs/general.py b/cogs/general.py
@@ -3,7 +3,7 @@
 Description:
 This is a template to create your own discord bot in python.
 
-Version: 5.0
+Version: 5.1
 """
 
 import platform
@@ -22,6 +22,24 @@ class General(commands.Cog, name="general"):
     def __init__(self, bot):
         self.bot = bot
 
+    @commands.hybrid_command(
+        name="help",
+        description="List all commands the bot has loaded."
+    )
+    async def help(self, context: Context) -> None:
+        prefix = self.bot.config["prefix"]
+        embed = discord.Embed(title="Help", description="List of available commands:", color=0x9C84EF)
+        for i in self.bot.cogs:
+            cog = self.bot.get_cog(i.lower())
+            commands = cog.get_commands()
+            data = []
+            for command in commands:
+                description = command.description.partition('\n')[0]
+                data.append(f"{prefix}{command.name} - {description}")
+            help_text = "\n".join(data)
+            embed.add_field(name=i.capitalize(), value=f'```{help_text}```', inline=False)
+        await context.send(embed=embed)
+
     @commands.hybrid_command(
         name="botinfo",
         description="Get some useful (or not) information about the bot.",
diff --git a/cogs/moderation.py b/cogs/moderation.py
@@ -3,10 +3,9 @@
 Description:
 This is a template to create your own discord bot in python.
 
-Version: 5.0
+Version: 5.1
 """
 
-from doctest import debug_script
 import discord
 from discord import app_commands
 from discord.ext import commands
@@ -152,14 +151,23 @@ async def ban(self, context: Context, user: discord.User, reason: str = "Not spe
             )
             await context.send(embed=embed)
 
-    @commands.hybrid_command(
-        name="warn",
-        description="Warns a user in the server.",
+    @commands.hybrid_group(
+        name="warning",
+        description="Manage warnings of a user on a server.",
     )
     @commands.has_permissions(manage_messages=True)
     @checks.not_blacklisted()
+    async def warning(self, context: Context) -> None:
+        pass
+
+    @warning.command(
+        name="add",
+        description="Adds a warning to a user in the server.",
+    )
+    @checks.not_blacklisted()
+    @commands.has_permissions(manage_messages=True)
     @app_commands.describe(user="The user that should be warned.", reason="The reason why the user should be warned.")
-    async def warn(self, context: Context, user: discord.User, reason: str = "Not specified") -> None:
+    async def warning_add(self, context: Context, user: discord.User, reason: str = "Not specified") -> None:
         """
         Warns a user in his private messages.
 
@@ -185,14 +193,38 @@ async def warn(self, context: Context, user: discord.User, reason: str = "Not sp
             # Couldn't send a message in the private messages of the user
             await context.send(f"{member.mention}, you were warned by **{context.author}**!\nReason: {reason}")
 
-    @commands.hybrid_command(
-        name="warnings",
+    @warning.command(
+        name="remove",
+        description="Removes a warning from a user in the server.",
+    )
+    @checks.not_blacklisted()
+    @commands.has_permissions(manage_messages=True)
+    @app_commands.describe(user="The user that should get their warning removed.", warn_id="The ID of the warning that should be removed.")
+    async def warning_add(self, context: Context, user: discord.User, warn_id: int) -> None:
+        """
+        Warns a user in his private messages.
+
+        :param context: The hybrid command context.
+        :param user: The user that should get their warning removed.
+        :param warn_id: The ID of the warning that should be removed.
+        """
+        member = context.guild.get_member(user.id) or await context.guild.fetch_member(user.id)
+        total = db_manager.remove_warn(warn_id, user.id, context.guild.id)
+        embed = discord.Embed(
+            title="User Warn Removed!",
+            description=f"I've removed the warning **#{warn_id}** from **{member}**!\nTotal warns for this user: {total}",
+            color=0x9C84EF
+        )
+        await context.send(embed=embed)
+
+    @warning.command(
+        name="list",
         description="Shows the warnings of a user in the server.",
     )
     @commands.has_guild_permissions(manage_messages=True)
     @checks.not_blacklisted()
     @app_commands.describe(user="The user you want to get the warnings of.")
-    async def warnings(self, context: Context, user: discord.User):
+    async def warning_list(self, context: Context, user: discord.User):
         """
         Shows the warnings of a user in the server.
         
@@ -209,7 +241,7 @@ async def warnings(self, context: Context, user: discord.User):
             description = "This user has no warnings."
         else:
             for warning in warnings_list:
-                description += f"• Warned by <@{warning[2]}>: **{warning[3]}** (<t:{warning[4]}>)\n"
+                description += f"• Warned by <@{warning[2]}>: **{warning[3]}** (<t:{warning[4]}>) - Warn ID #{warning[5]}\n"
         embed.description = description
         await context.send(embed=embed)
 
diff --git a/cogs/owner.py b/cogs/owner.py
@@ -3,7 +3,7 @@
 Description:
 This is a template to create your own discord bot in python.
 
-Version: 5.0
+Version: 5.1
 """
 
 import json
diff --git a/cogs/template.py b/cogs/template.py
@@ -3,7 +3,7 @@
 Description:
 This is a template to create your own discord bot in python.
 
-Version: 5.0
+Version: 5.1
 """
 
 from discord.ext import commands
diff --git a/database/schema.sql b/database/schema.sql
@@ -4,6 +4,7 @@ CREATE TABLE IF NOT EXISTS `blacklist` (
 );
 
 CREATE TABLE IF NOT EXISTS `warns` (
+  `id` int(11) NOT NULL,
   `user_id` varchar(20) NOT NULL,
   `server_id` varchar(20) NOT NULL,
   `moderator_id` varchar(20) NOT NULL,
diff --git a/exceptions/__init__.py b/exceptions/__init__.py
@@ -3,7 +3,7 @@
 Description:
 This is a template to create your own discord bot in python.
 
-Version: 5.0
+Version: 5.1
 """
 
 from discord.ext import commands
diff --git a/helpers/checks.py b/helpers/checks.py
@@ -3,7 +3,7 @@
 Description:
 This is a template to create your own discord bot in python.
 
-Version: 5.0
+Version: 5.1
 """
 
 import json
diff --git a/helpers/db_manager.py b/helpers/db_manager.py
@@ -3,7 +3,7 @@
 Description:
 This is a template to create your own discord bot in python.
 
-Version: 5.0
+Version: 5.1
 """
 
 import sqlite3
@@ -62,13 +62,32 @@ def add_warn(user_id: int, server_id: int, moderator_id: int, reason: str) -> in
     """
     connection = sqlite3.connect("database/database.db")
     cursor = connection.cursor()
-    cursor.execute("INSERT INTO warns(user_id, server_id, moderator_id, reason) VALUES (?, ?, ?, ?)", (user_id, server_id, moderator_id, reason))
+    # Get the last `id`
+    rows = cursor.execute("SELECT id FROM warns WHERE user_id=? AND server_id=? ORDER BY id DESC LIMIT 1", (user_id, server_id,)).fetchone()
+    warn_id = rows[0]+1 if rows is not None else 1
+    cursor.execute("INSERT INTO warns(id, user_id, server_id, moderator_id, reason) VALUES (?, ?, ?, ?, ?)", (warn_id, user_id, server_id, moderator_id, reason,))
     connection.commit()
     rows = cursor.execute("SELECT COUNT(*) FROM warns WHERE user_id=? AND server_id=?", (user_id, server_id,)).fetchone()[0]
     connection.close()
     return rows
 
 
+def remove_warn(warn_id: int, user_id: int, server_id: int) -> int:
+    """
+    This function will remove a warn from the database.
+    
+    :param warn_id: The ID of the warn.
+    :param user_id: The ID of the user that was warned.
+    :param server_id: The ID of the server where the user has been warned
+    """
+    connection = sqlite3.connect("database/database.db")
+    cursor = connection.cursor()
+    cursor.execute("DELETE FROM warns WHERE id=? AND user_id=? AND server_id=?", (warn_id, user_id, server_id,))
+    connection.commit()
+    rows = cursor.execute("SELECT COUNT(*) FROM warns WHERE user_id=? AND server_id=?", (user_id, server_id,)).fetchone()[0]
+    connection.close()
+    return rows
+
 def get_warnings(user_id: int, server_id: int) -> list:
     """
     This function will get all the warnings of a user.
@@ -79,7 +98,7 @@ def get_warnings(user_id: int, server_id: int) -> list:
     """
     connection = sqlite3.connect("database/database.db")
     cursor = connection.cursor()
-    cursor.execute("SELECT user_id, server_id, moderator_id, reason, strftime('%s', created_at) FROM warns WHERE user_id=? AND server_id=?", (user_id, server_id,))
+    cursor.execute("SELECT user_id, server_id, moderator_id, reason, strftime('%s', created_at), id FROM warns WHERE user_id=? AND server_id=?", (user_id, server_id,))
     result = cursor.fetchall()
     connection.close()
     return result
