Merge pull request #35 from LewisProjects/development

New release

Author: JasonLovesDoggo

CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing to Ogiroid 🤝!
+🎊👏 Firstly, thank you so much for taking out time to contribute to Ogiroid! 👏🎊
+
+The following is a set of guidelines for contributing to Ogiroid, which is a part of [Lewis Projects](https://github.com/LewisProjects/) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+### Table of Contents:
+1. [Code of Conduct](#code-of-conduct)
+2. [What do I require before getting started?](#prerequisites)
+3. [What can I do to contribute?](#contribution)
+4. [Additional Notes]()
+
+<hr>
+
+## [Code of Conduct](#code-of-conduct)
+> This project and everyone participating in it is governed by the Ogiroid code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the developers.
+
+## [What do I require before getting started?](#prerequisites)
+We expect you to be experienced with [Python](https://www.python.org/) and [Disnake](https://disnake.dev/) (a fork of [Discord.py](https://github.com/Rapptz/discord.py)). Having experience with Discord.py should also get you sailing, disnake and discord.py are almost the same. 
+
+## [What can I do to contribute?](#contribution) 
+**1. Reporting any bugs 🐞:**
+
+Cannot emphasize enough how much bug reporting/bug fixing helps us! It saves us numerous hours of painful code scouting. So you might ask yourself, how do I submit a bug report for Ogiroid? Quite simple honestly! First of all, did you:
++ Come across a bug while using the Discord bot? 
++ Come across a bug in the code?
+
+**Case 1: While using the Discord Bot:**
+
+You need to headover to a channel in [Lewis' Menelaws discord server](https://discord.com/5uw4eCQf6Z) and then type: ``/reportbug``, you will then be greeted by a modal looking something like this:
+
+![MODAL](https://cdn.discordapp.com/attachments/1005117336761675847/1007706426896040077/unknown.png)
+
+Fill this form & click **submit**. Our developer team will then recieve your bug report, we can then look into it 😇! Thank you!
+
+**Case 2: A bug in the code (hmmm... quite rare 😜):**
+
+You can raise an [issue](https://github.com/LewisProjects/Ogiroid/issues) and we will look into it. Please ensure you follow the proper [format we have](#) and be as specific as you can while reporting a bug. Obviously, there can be somee cases where the format might not be as important as in other cases, please use your judgement in such cases.
+
+Alternatively, you can headover to our [Discord Server](https://discord.com/5uw4eCQf6Z) and report the bug using the first method (scroll up if you missed it).
+
+**__📚📚 Bug Reporting Guidelines 📚📚:__**
+
++ Please refrain from reporting your bug multiple times, this will lead to us blacklisting you (and potentially banning you permanently on the Discord server) 😒.
++ Please check all the [issues](https://github.com/LewisProjects/Ogiroid/issues) before posting your bug, your bug report could really just be a duplicate 👀!
++ Please ensure you be as specific as you can, this saves us a ton of time ⌚.
++ Please use your right judgement 🎓. 
+
+With that being said, you have officially reported a bug! Thank you so much 🤩!
+
+<!--Contributing.md: writeup #1-->

README.md

@@ -1,9 +1,9 @@
-<h1>Ogiroid - a multipurpose discord bot!</h1>
+<h1>Ogiroid - the most handsome Discord bot!</h1>
 <hr>
 <img src="https://media.discordapp.net/attachments/985729550732394536/1002138392554897479/Ogiroid.png?width=1440&height=583" alt="img">
 <hr>
 <h3>Introduction:</h3>
-Ogiroid is a multipurpose Discord Bot developed for the YouTuber, <a href="https://www.youtube.com/c/CodingwithLewis">Lewis Menelaws'</a> Discord Server.
+Ogiroid is a multipurpose Discord Bot (who is very handsome 😋😋) developed for the YouTuber, <a href="https://www.youtube.com/c/CodingwithLewis">Lewis Menelaws'</a> Discord Server.
 This bot offers:
 <ul>
 <li>Fun Commands, example: /askogiroid, /beer, /sus and more! </li>
@@ -22,6 +22,7 @@ This bot offers:
 <hr>
 <h3>Bot Development Information:</h3>
 <p>Written in: <b>Python</b><br>Made using <a href="https://disnake.dev/">Disnake</a>, a Discord.py fork!</p>
+<p>NOTE: you need to use python 3.8+ for this bot</p>
 Developers:
 <ul>
 <li><a href="https://github.com/ImmaHarry">HarryDaDev</a></li>
@@ -30,8 +31,9 @@ Developers:
 <li><a href="https://github.com/LevaniVashadze">Levani Vashadze</a></li>
 <li><a href="https://github.com/DWAA1660">DWAA1660</a></li>
 </ul>
-The bot is currently on release: <b>1.6.0</b>
-License: MIT
+The bot is currently on release: <b>1.6.0</b><br>
+License: MIT<br>
+Wish to Contribute to this bot? Checkout: <a href="https://github.com/LewisProjects/Ogiroid/blob/development/contributing.md">contribution guidelines</a>
 <hr>
 <h3>Changelog 07-08-2022:</h3>
 <ol>

cogs/ErrorHandler.py

@@ -4,54 +4,67 @@
 from datetime import datetime
 
 import disnake
-from disnake import Embed
-from disnake.ext import commands
+from disnake import Embed, ApplicationCommandInteraction, HTTPException
+from disnake.ext.commands import *
 
 from utils.CONSTANTS import IGNORE_EXCEPTIONS
 from utils.bot import OGIROID
+from utils.shortcuts import errorEmb, permsEmb
 
 
-class ErrorHandler(commands.Cog):
+class ErrorHandler(Cog):
     def __init__(self, bot: OGIROID):
         self.bot = bot
         self.debug_mode = self.bot.config.debug
+        self.waitTime = 25
+
+    def TimeSinceStart(self) -> int:
+        return round((datetime.now() - self.bot.uptime).total_seconds(), ndigits=1)
 
     # noinspection PyUnboundLocalVariable
-    @commands.Cog.listener()
-    async def on_slash_command_error(self, inter, error):
+    @Cog.listener()
+    async def on_slash_command_error(self, inter: ApplicationCommandInteraction, error):
         try:
             if hasattr(inter.application_command, "on_error"):
                 return
             elif error.__class__.__name__ in IGNORE_EXCEPTIONS:
                 return
-            else:
-                error_channel = self.bot.get_channel(self.bot.config.channels.errors)
-
-                embed: Embed = await self.create_error_message(inter, error)
-                await inter.send(embed=embed, ephemeral=True)
-                bot_errors = traceback.format_exception(type(error), error, error.__traceback__)
-                if self.bot.config.debug:
-                    print(bot_errors)
-
-                error_embed = disnake.Embed(
-                    title="Error Traceback",
-                    description=f"See below!\n\n{bot_errors}",
-                    timestamp=datetime.utcnow(),
+            if self.TimeSinceStart() < self.waitTime:  # Databases and internal caches might not be fully loaded yet
+                return await errorEmb(
+                    inter, f"The bot just started, please wait {round(self.waitTime - self.TimeSinceStart(), ndigits=2)}s."
                 )
-                await error_channel.send(embed=error_embed)
-                traceback_nice = "".join(traceback.format_exception(type(error), error, error.__traceback__, 4)).replace(
-                    "```", "```"
+            # non real error handling
+            if isinstance(error, CommandNotFound):
+                return await errorEmb(inter, "Command not found! use /help for a list of commands")
+            elif isinstance(error, NotOwner):
+                await errorEmb(
+                    inter, f"You must be the owner of {inter.me.display_name} to use `{inter.application_command.name}`"
                 )
-
-                debug_info = (
-                    f"```\n{inter.author} {inter.author.id}: /{inter.application_command.name}"[:200]
-                    + "```"
-                    + f"```py\n{traceback_nice}"[: 2000 - 206]
-                    + "```"
+            elif isinstance(error, HTTPException):
+                await errorEmb(inter, error.text)
+                return await self.send_traceback(inter, error)
+            elif isinstance(error, MissingPermissions):
+                return await permsEmb(inter, permissions=f"{', '.join(error.missing_permissions)}")
+            elif isinstance(error, MaxConcurrencyReached):
+                return await errorEmb(
+                    inter, "You've reached max capacity of command usage at once, please finish the previous one..."
                 )
-                await error_channel.send(debug_info)
+            elif isinstance(error, CommandOnCooldown):
+                return await errorEmb(inter, f"This command is on cooldown... try again in {error.retry_after:.2f} seconds.")
+            elif isinstance(error, GuildNotFound):
+                return await errorEmb(error, f"You can only use this command in a server")
+            elif self.debug_mode:
+                traceback_nice = "".join(traceback.format_exception(type(error), error, error.__traceback__, 4))
+                print(traceback_nice)
+                traceback.print_exc()
+                return await errorEmb(inter, "check console for error")
+            else:  # actual error not just a check failure
+                embed = await self.create_error_message(inter, error)
+                await inter.send(embed=embed, ephemeral=True)
+                await self.send_traceback(inter, error)
 
         except Exception as e:
+            error_channel = self.bot.get_channel(self.bot.config.channels.errors)
             embed = await self.create_error_message(inter, e)
             await inter.send(embed=embed, ephemeral=True)
             e_traceback = traceback.format_exception(type(e), e, e.__traceback__)
@@ -76,10 +89,30 @@ async def on_slash_command_error(self, inter, error):
             )
             await error_channel.send(debug_info_e)
 
+    async def send_traceback(self, inter, error):
+        error_channel = self.bot.get_channel(self.bot.config.channels.errors)
+        bot_errors = traceback.format_exception(type(error), error, error.__traceback__)
+
+        error_embed = disnake.Embed(
+            title="Error Traceback",
+            description=f"See below!\n\n{bot_errors}",
+            timestamp=datetime.utcnow(),
+        )
+        await error_channel.send(embed=error_embed)
+        traceback_nice = "".join(traceback.format_exception(type(error), error, error.__traceback__, 4)).replace("```", "```")
+
+        debug_info = (
+            f"```\n{inter.author} {inter.author.id}: /{inter.application_command.name}"[:200]
+            + "```"
+            + f"```py\n{traceback_nice}"[: 2000 - 206]
+            + "```"
+        )
+        await error_channel.send(debug_info)
+
     @staticmethod
-    async def create_error_message(inter, error):
+    async def create_error_message(inter, error) -> Embed:
         embed = disnake.Embed(
-            title=f"❌An error occurred while executing: ``/{inter.application_command.name}``",
+            title=f"❌An error occurred while executing: ``/{inter.application_command.qualified_name}``",
             description=f"{error}",
             colour=disnake.Color.blurple(),
             timestamp=datetime.utcnow(),

cogs/blacklist.py

@@ -8,13 +8,12 @@
 from disnake.ext.commands import Cog
 
 from utils import timeconversions
-from utils.DBhandelers import BlacklistHandler
+from utils.CONSTANTS import timings
+from utils.DBhandlers import BlacklistHandler
 from utils.models import BlacklistedUser
 from utils.pagination import CreatePaginator
 from utils.shortcuts import sucEmb, errorEmb, get_expiry, wait_until
 
-HOUR = 3600
-
 if TYPE_CHECKING:
     from utils.bot import OGIROID
 
@@ -49,15 +48,16 @@ async def check_user_removal(self, user: BlacklistedUser):
             return  # already being removed
         elif user.is_expired():
             return True
-        elif int(time.time()) <= user.expires <= (int(time.time()) + HOUR):
+        elif int(time.time()) <= user.expires <= (int(time.time()) + timings.HOUR):
             self.del_que.append(user.id)
             await self.run_at(user.expires, self.blacklist.remove, user.id)
 
     @commands.Cog.listener()
     async def on_ready(self):
-        await self.bot.wait_until_ready()
-        self.blacklist: BlacklistHandler = self.bot.blacklist
-        self.check_blacklist.start()
+        if not self.bot.ready_:
+            await self.bot.wait_until_ready()
+            self.blacklist: BlacklistHandler = self.bot.blacklist
+            self.check_blacklist.start()
 
     @commands.slash_command(description="Blacklist base command", hidden=True)
     async def blacklist(self, inter):
@@ -68,7 +68,7 @@ async def blacklist(self, inter):
     async def blacklist_info(self, inter, user: Member):
         if not await self.blacklist.blacklisted(user.id):
             return await errorEmb(inter, f"{user.mention} is not in the blacklist")
-        bl_user = self.blacklist.get_user(user.id)
+        bl_user = await self.blacklist.get_user(user.id)
         embed = Embed(title=f"Blacklisted user: {user.name}", color=disnake.Color.random(seed=user.name))
         embed.add_field(name="Reason", value=bl_user.reason, inline=False)
         embed.add_field(name="Expires", value=bl_user.get_expiry, inline=False)
@@ -107,7 +107,7 @@ async def expiry(self, inter, user: Member, expires: str):
         expiry = int((await timeconversions.convert(expires)).dt.timestamp())
         await self.blacklist.edit_expiry(user.id, expiry)
         await sucEmb(inter, f"Edited the expiry of {user.mention}'s blacklist to expire {get_expiry(expiry)}")
-        await self.check_user_removal(self.blacklist.get_user(user.id))
+        await self.check_user_removal(await self.blacklist.get_user(user.id))
 
     @commands.has_permissions(manage_messages=True)
     @blacklist.sub_command(name="remove", description="Remove a user from the blacklist")
@@ -158,7 +158,7 @@ async def blacklist_add(self, inter, user, bot, tickets, tags, reason="No Reason
             f"{user.mention} added to blacklist\nthe user's blacklist will {f'expire on <t:{int(expires)}:R>' if str(expires) != str(9999999999) else 'never expire'}",
             ephemeral=False,
         )
-        await self.check_user_removal(self.blacklist.get_user(user.id))
+        await self.check_user_removal(await self.blacklist.get_user(user.id))
 
     @commands.cooldown(1, 30, commands.BucketType.user)
     @blacklist.sub_command(name="list", description="List all blacklisted users")

cogs/botcmds.py

@@ -5,7 +5,7 @@
 import disnake
 from disnake.ext import commands
 
-from utils.CONSTANTS import status
+from utils.CONSTANTS import status, __VERSION__
 from utils.bot import OGIROID
 from utils.shortcuts import QuickEmb
 
@@ -80,22 +80,28 @@ async def botinfo(self, inter):
         """Shows the info of the bot"""
         embed = disnake.Embed(title="Ogiroid Information: ", description=" ", color=0xFFFFFF)
         embed.add_field(name="**Bot Name: **", value=f"```>> Ogiroid```", inline=False)
-        embed.add_field(name="**Bot Version: **", value=f"```>> 1.4.0```", inline=False)
+        embed.add_field(name="**Bot Version: **", value=f"```>> {__VERSION__}```", inline=False)
         embed.add_field(
             name="**Disnake Version: **",
             value=f"```>> {disnake.__version__}```",
             inline=False,
         )
         embed.add_field(
             name="**Bot Developers: **",
-            value=f"__Owners:__\n`>` **[FreebieII](https://github.com/FreebieII) (<@744998591365513227>)** \n`>` **[HarryDaDev](https://github.com/ImmaHarry) (<@963860161976467498>) **\n\n__Contributors:__\n**`>`[JasonLovesDoggo](https://github.com/JasonLovesDoggo) (<@511724576674414600>),\n`>`[DWAA1660](https://github.com/DWAA1660) (<@491266830674034699>), \n`>`[LevaniVashadze](https://github.com/LevaniVashadze) (<@662656158129192961>),\n`>`[CordlessCoder](https://github.com/CordlessCoder) (<@577885109894512659>).**",
+            value=f"__Owners:__\n`>` **[FreebieII](https://github.com/FreebieII) (<@744998591365513227>)** \n"
+            f"`>` **[HarryDaDev](https://github.com/ImmaHarry) (<@963860161976467498>) **\n\n"
+            f"__Contributors:__\n**`>`[JasonLovesDoggo](https://github.com/JasonLovesDoggo) (<@511724576674414600>)\n"
+            f"`>`[DWAA1660](https://github.com/DWAA1660) (<@491266830674034699>) \n"
+            f"`>`[LevaniVashadze](https://github.com/LevaniVashadze) (<@662656158129192961>)\n"
+            f"`>`[CordlessCoder](https://github.com/CordlessCoder) (<@577885109894512659>)**",
             inline=False,
         )
         embed.set_thumbnail(
             url="https://cdn.discordapp.com/attachments/985729550732394536/987287532146393109/discord-avatar-512-NACNJ.png"
         )
 
-        await inter.response.send_message(embed=embed)
+        button = disnake.ui.Button(label="Source", style=disnake.ButtonStyle.url, url="https://github.com/LewisProjects/Ogiroid")
+        await inter.send(embed=embed, components=button)
 
     @commands.slash_command()
     @commands.guild_only()
@@ -254,6 +260,17 @@ async def whois(self, inter, *, user: disnake.Member = None):
 
         await inter.send(embed=e)
 
+    @commands.slash_command(name="avatar", description="Shows the avatar of a user.")
+    async def avatar(self, inter: disnake.ApplicationCommandInteraction, user: disnake.Member = None):
+        """Shows the avatar of a user."""
+        if user == None:
+            user = inter.author
+
+        embed = disnake.Embed(title=f"{user}'s avatar")
+        embed.set_image(url=user.avatar.url)
+        embed.set_author(name=f"{user}", icon_url=user.avatar.url)
+        await inter.send(embed=embed)
+
 
 def setup(bot):
     bot.add_cog(Commands(bot))

cogs/code.py

@@ -7,6 +7,7 @@
 from utils.CONSTANTS import VALID_CODE_LANGUAGES
 from utils.bot import OGIROID
 from utils.http import session
+from utils.shortcuts import errorEmb
 
 
 class CodeExec(Cog, name="Code"):
@@ -77,7 +78,10 @@ async def run_code(*, lang: str, code: str):
 
     @staticmethod
     async def _send_result(inter, result: dict):
-        output = result["output"]
+        try:
+            output = result["output"]
+        except KeyError:
+            return await errorEmb(inter, result["message"])
         # if len(output) > 2000: HAVE TO FIX THIS!!!!
         # url = await create_guest_paste_bin(self.session, output)
         # return await ctx.reply("Your output was too long, so here's the pastebin link " + url)