Merge pull request #8 from Gitfoe/dev

v1.0.1

Author: RillJ

README.md

@@ -22,7 +22,7 @@ One of the distinctive features of ChadCounting is the catch-up feature. In case
 - Counts any message that starts with a number.
 
 ## Usage
-To configure the bot for the first time, add it to your Discord server and use the `/setchannel` command to let the bot know where it should keep track of counting. After that, ChadCounting is up and running and you can start competing!
+To configure the bot for the first time, add it to your Discord server and use the `/set channel` command to let the bot know where it should keep track of counting. After that, ChadCounting is up and running and you can start competing!
 
 ## Commands
 The following commands could be used:
@@ -51,7 +51,11 @@ pip3 install -U pytz (confirmed with version 2023.3.post1)
 When creating your own fork of ChadCounting, ensure your bot has at least the `Send Message`, `Read Message History` and `Add Reactions` OAuth2 permissions. `Use External Emojis` is an optional permission, but recommended. The scope should be `bot`.
 
 ### Dev-mode
-In the `Initialisation` region of the `bot.py` file, `dev_mode` can be enabled to facilitate the testing of real-world scenarios. By enabling `dev-mode`, the bot can be configured to operate solely within a designated (testing) guild, thus preventing beta code from impacting production guilds. It is recommended to have two separate Discord bots, one for production and one for development, to safely test new code without putting the production environment at risk.
+In the `Initialisation` region of the `bot.py` file, two development options can be enabled to facilitate the testing of real-world scenarios.
+
+The first option, `dev_active_single_guild`, can be enabled to configure the bot to operate solely within a designated (testing) guild, thus preventing beta code from impacting production guilds. The `dev_mode_guild_id` should be set to the ID of this testing guild. This allows you to safely test new code without putting the production environment at risk.
+
+The second option, `dev_disable_apis`, can be enabled to disable connections to APIs such as the bot websites top.gg and discordbotlist during development. It is recommended to have two separate Discord bots, one for production and one for development, to safely test new code. This option should be enabled when using a development bot account to prevent pushing the development bot's data to the APIs.
 
 [Link to add ChadCounting Dev to a guild](https://discord.com/api/oauth2/authorize?client_id=1069230219094921318&permissions=329792&scope=bot)
 
@@ -62,12 +66,17 @@ Counting and guild data is saved to a JSON database, eliminating the need for ex
 For added security and to comply by Discord's ToS, create a .env file in the root directory of the ChadCounting bot folder (where bot.py is located). This file serves as the designated location to securely store bot tokens. To add your Discord bot tokens, follow the example below:
 ```
 # .env
-DISCORD_TOKEN=your_discord_bot_token
-DEV_TOKEN=your_discord_dev_bot_token
+DISCORD_TOKEN=token_here
+DEV_TOKEN=token_here
+DISCORDBOTLIST_TOKEN=token_here
+TOPGG_TOKEN=token_here
+DISCORDS_TOKEN=token_here
+DISCORDBOTSGG_TOKEN=token_here
 ```
 
 ### Versioning
 To properly manage versioning, it is recommended to update the `bot_version` variable in the `Initialization` section of the `bot.py` file every time a functional version is ready to be pulled to the `main` branch. This version will be displayed in the output of the `/help` command. ChadCounting uses semantic versioning and a version number is written as `MAJOR.MINOR.PATCH`, where:
 - `MAJOR` version is increased for incompatible changes to previous versions.
 - `MINOR` version is increased for new features that are backward-compatible.
 - `PATCH` version is increased for backward-compatible bug fixes.
+When you are working on a new version and commit to the `dev` branch, ensure the version temporarily ends with `-indev` to indicate that the version is in development and might not function yet.

bot.py

@@ -8,6 +8,7 @@
 import pytz
 import emoji
 import discord
+import requests
 import traceback
 import statistics
 import matplotlib.pyplot as plt
@@ -21,19 +22,30 @@
 
 #region Initialisation
 # For developing only
-dev_mode = False # Make the bot only active in a certain guild
-dev_mode_guild_id = 574350984495628436 # Bot must be in this guild already
+dev_disable_apis = False # Disable connecting to APIs such as bot websites
+dev_active_single_guild = False # Make the bot only active in a certain guild
+dev_mode_guild_id = 574350984495628436 # If the above is true, bot must be in this guild already
 update_guild_data = False # Forces updating of newly added guild_data values after a ChadCounting update
 
 # Initialize variables and load environment tables
 load_dotenv()
-TOKEN = os.getenv("DISCORD_TOKEN") # Normal ChadCounting token
+PROD_TOKEN = os.getenv("PROD_TOKEN") # Normal ChadCounting token
 DEV_TOKEN = os.getenv("DEV_TOKEN") # ChadCounting Dev bot account token
-guild_data = {} # DB
-bot_version = "1.0.0"
-chadcounting_color = 0xCA93FF
+guild_data = {} # Global variable for database
+bot_version = "1.0.1"
+chadcounting_color = 0xCA93FF # Color of the embeds
 image_gigachad = "https://github.com/Gitfoe/ChadCounting/blob/main/gigachad.jpeg?raw=true"
 
+# Initialize API tokens and URIs
+DISCORDBOTLIST_TOKEN = os.getenv("DISCORDBOTLIST_TOKEN")
+TOPGG_TOKEN = os.getenv("TOPGG_TOKEN")
+DISCORDS_TOKEN = os.getenv("DISCORDS_TOKEN")
+DISCORDBOTSGG_TOKEN = os.getenv("DISCORDBOTSGG_TOKEN")
+api_discordbotslist = "https://discordbotlist.com/api/v1/bots/chadcounting"
+api_topgg = "https://top.gg/api/bots/1066081427935993886"
+api_discords = "https://discords.com/bots/api/bot/1066081427935993886"
+api_discordbotsgg = "https://discord.bots.gg/api/v1/bots/1066081427935993886"
+
 # Initialize bot and intents
 intents = discord.Intents.default()
 intents.message_content = True
@@ -44,22 +56,26 @@
 @bot.event
 async def on_ready():
     """Discord event that gets triggered once the connection has been established."""
+    # Setup and sync commands
     await setup_grouped_commands(bot)
-    try: # Sync bot commands
-        synced = await bot.tree.sync()
+    try:
+        await bot.tree.sync() # Sync commands to Discord
+        push_commands_to_discordbotlist() # Sync commands to Discordbotlist
+        push_guilds_count_to_all_bot_websites() # Sync guilds count to bot lists
     except Exception as e:
         print(e)
+    # Initialise database
     init_guild_data()
     for guild in bot.guilds:
-        if not dev_mode or (dev_mode and guild.id == dev_mode_guild_id):
+        if not dev_active_single_guild or (dev_active_single_guild and guild.id == dev_mode_guild_id):
             await check_for_missed_counts(guild.id)
     print(f"[{datetime.now()}] ChadCounting is ready.")
 
 @bot.event
 async def on_resumed():
     """Discord event that gets triggered once a bot gets resumed from a paused session."""
     for guild in bot.guilds:
-        if not dev_mode or (dev_mode and guild.id == dev_mode_guild_id):
+        if not dev_active_single_guild or (dev_active_single_guild and guild.id == dev_mode_guild_id):
             await check_for_missed_counts(guild.id)
     print(f"[{datetime.now()}] ChadCounting has resumed.")
 
@@ -79,7 +95,7 @@ async def on_message_delete(message):
     guild_id = message.guild.id
     current_count = guild_data[guild_id]["current_count"]
     # Ignores messages sent by bots, and if dev_mode is on, exit if message is not from dev mode guild
-    if message.author.bot or dev_mode and not guild_id == dev_mode_guild_id:
+    if message.author.bot or dev_active_single_guild and not guild_id == dev_mode_guild_id:
         return
     last_count = guild_data[guild_id]["previous_message"]
     if message.created_at == last_count:
@@ -113,6 +129,7 @@ async def on_guild_join(guild):
     if bot.is_ready() is not True:
         return
     add_guild_to_guild_data(guild.id)
+    push_guilds_count_to_all_bot_websites() # Sync guilds count with bot lists
 #endregion                                               
 
 #region Counting logic
@@ -168,7 +185,7 @@ async def check_count_message(message):
     """Returns True if the message was a correct count and False if it was incorrect. Returns nothing if count wasn't checked."""
     global guild_data
     # Ignores messages sent by bots, and if dev_mode is on, exit if message is not from dev mode guild
-    if message.author.bot or dev_mode and not message.guild.id == dev_mode_guild_id:
+    if message.author.bot or dev_active_single_guild and not message.guild.id == dev_mode_guild_id:
         return
     # Checks if the message is sent in counting channel and starts with a number
     elif message.channel.id == guild_data[message.guild.id]["counting_channel"] and len(message.content) > 0 and message.content[0].isnumeric():
@@ -304,11 +321,11 @@ def init_guild_data():
         raise Exception("There was an error decoding guild_data.json.")
     finally:
         for guild in bot.guilds:
-            if not dev_mode or (dev_mode and guild.id == dev_mode_guild_id):
+            if not dev_active_single_guild or (dev_active_single_guild and guild.id == dev_mode_guild_id):
                 add_or_update_new_guild_data(guild.id)
         if update_guild_data: # If updating is on, also check the existing guilds in guild_data (if the bot left a guild)
             for guild_id in guild_data:
-                if not dev_mode or (dev_mode and guild_id == dev_mode_guild_id):
+                if not dev_active_single_guild or (dev_active_single_guild and guild_id == dev_mode_guild_id):
                     add_or_update_new_guild_data(guild_id)
         print(f"[{datetime.now()}] Successfully loaded {len(guild_data)} guild(s).")
 
@@ -580,6 +597,12 @@ def chadcounting_embed(title, description=None):
     embed = discord.Embed(title=title, description=description, color=chadcounting_color)
     embed.set_thumbnail(url=image_gigachad)
     return embed
+
+def check_dev_disable_apis(executing_method_name):
+    """Prints to the console if 'dev_disable_apis' is enabled."""
+    if dev_disable_apis:
+        print(f"[{datetime.now()}] {executing_method_name}: dev_disable_apis is enabled, method will exit.")
+    return dev_disable_apis
 #endregion
 
 #region Command helper functions
@@ -625,7 +648,7 @@ async def check_correct_channel(interaction):
     channel_error = f"You can only execute ChadCounting commands in the counting channel, "
     if counting_channel == None:
         channel_error += (f"however, it has not been set yet. " +
-                          f"If you are an admin of this server, use the command `/setchannel` in the channel you want to count in.")
+                          f"If you are an admin of this server, use the command `/set channel` in the channel you want to count in.")
         embed.add_field(name="", value=channel_error)
         await interaction.response.send_message(embed=embed, ephemeral=True)
         return False
@@ -649,6 +672,13 @@ async def check_bot_ready(interaction):
         await interaction.response.send_message(embed=embed, ephemeral=True)
         return False
     return True
+
+def get_all_commands(bot):
+    """Returns a list of all the commands the bot has."""
+    return [
+        *bot.walk_commands(),
+        *bot.tree.walk_commands()
+    ]
 #endregion
 
 #region View subclasses
@@ -689,6 +719,7 @@ def __init__(self):
             {"label": "More information", "url": "https://github.com/Gitfoe/ChadCounting", "emoji": "ℹ️"},
             {"label": "Vote on top.gg", "url": "https://top.gg/bot/1066081427935993886/vote", "emoji": "⬆️"},
             {"label": "Vote on discordbotlist", "url": "https://discordbotlist.com/bots/chadcounting/upvote", "emoji": "⬆️"},
+            {"label": "Vote on discords", "url": "https://discordbotlist.com/bots/chadcounting/upvote", "emoji": "⬆️"},
         ]
         for button in buttons:
             self.add_item(Button(**button))
@@ -716,7 +747,7 @@ async def help(interaction: discord.Integration):
     except Exception as e:
         await command_exception(interaction, e)
 
-class SetCog(commands.GroupCog, name="set"):
+class SetCog(commands.GroupCog, name="set", description="Admins only: sets and configures various settings for ChadCounting."):
     def __init__(self, bot: commands.Bot) -> None:
         self.bot = bot
         super().__init__()
@@ -934,7 +965,7 @@ async def set_reactions(self, interaction: discord.Integration, correct_reaction
         except Exception as e:
             await command_exception(interaction, e)
 
-class CountCog(commands.GroupCog, name="count"):
+class CountCog(commands.GroupCog, name="count", description="Gives various counting statusses."):
     def __init__(self, bot: commands.Bot) -> None:
         self.bot = bot
         super().__init__()
@@ -1058,7 +1089,7 @@ async def banrate(interaction: discord.Integration):
     except Exception as e:
         await command_exception(interaction, e)
 
-class StatsCog(commands.GroupCog, name="stats"):
+class StatsCog(commands.GroupCog, name="stats", description="Gives various counting statistics."):
     def __init__(self, bot: commands.Bot) -> None:
         self.bot = bot
         super().__init__()
@@ -1135,7 +1166,7 @@ async def stats_server(self, interaction: discord.Integration) -> None:
                 total_counts = correct_counts + incorrect_counts
                 if total_counts > 0:
                     percent_correct = round((correct_counts / (total_counts)) * 100, 2)
-                full_text += f"**{i+1}. {user_id}** {total_counts} total counts ({percent_correct}% correct) {correct_counts} correct and {incorrect_counts} incorrect counts\n"
+                full_text += f"**{i+1}. {user_id}**{total_counts} total counts ({percent_correct}% correct) {correct_counts} correct and {incorrect_counts} incorrect counts\n"
             if len(full_text) > 0:
                 embed = chadcounting_embed("Here you go, the server statistics")
                 embed.add_field(name="", value=full_text)
@@ -1151,31 +1182,75 @@ async def serverstats(self, interaction: discord.Interaction) -> None:
         try:
             if not await check_bot_ready(interaction) or not await check_correct_channel(interaction):
                 return
-            server_stats = []
-            for guild_id, users in guild_data.items():
-                total_correct_counts = sum(user_data["correct_counts"] for user_data in users["users"].values())
-                total_incorrect_counts = sum(user_data["incorrect_counts"] for user_data in users["users"].values())
-                total_counts = total_correct_counts + total_incorrect_counts
-                highest_count = guild_data[guild_id]["highest_count"]
-                current_count = guild_data[guild_id]["current_count"]
-                if total_counts > 0:
-                    percent_correct = round((total_correct_counts / total_counts) * 100, 2)
-                    server_stats.append((guild_id, highest_count, total_counts, percent_correct, current_count))
-            sorted_server_stats = sorted(server_stats, key=lambda x: x[1], reverse=True)[:10]
-            full_text = ""
-            for i, (guild_id, highest_count, total_counts, percent_correct, current_count) in enumerate(sorted_server_stats):
-                guild = discord.utils.get(bot.guilds, id=guild_id)
-                name_of_guild = guild.name if guild else "*Unknown server*"
-                full_text += f"**{i+1}. {name_of_guild}** Highest count: {highest_count}, total: {total_counts} ({percent_correct}% correct), current: {current_count}\n"
+            guild_ids_bot_is_in = {guild.id for guild in bot.guilds}
+            server_stats = [
+                (
+                    guild_id,
+                    guild_data[guild_id]["highest_count"],
+                    total_counts := sum(user_data["correct_counts"] + user_data["incorrect_counts"] for user_data in users["users"].values()),
+                    round((sum(user_data["correct_counts"] for user_data in users["users"].values()) / total_counts) * 100, 2) if total_counts > 0 else 0,
+                    guild_data[guild_id]["current_count"]
+                )
+                for guild_id, users in guild_data.items() if guild_id in guild_ids_bot_is_in
+            ]
+            # Sort by high score, then percent correct, then total counts
+            sorted_server_stats = sorted(server_stats, key=lambda x: (x[1], x[3], x[2]), reverse=True)[:10]
+            full_text = "\n".join(
+                f"**{i+1}. {discord.utils.get(bot.guilds, id=guild_id).name}**Highest count: {highest_count}, total: {total_counts} ({percent_correct}% correct), current: {current_count}"
+                for i, (guild_id, highest_count, total_counts, percent_correct, current_count) in enumerate(sorted_server_stats)
+            )
             embed = chadcounting_embed("Here you go, the best servers on ChadCounting")
-            if len(full_text) > 0:
-                embed.add_field(name="", value=full_text)
-            else:
-                embed.add_field(name="", value="No servers have participated in ChadCounting yet. Shame. Start counting!")
+            embed.add_field(name="", value=full_text if full_text else "No servers have participated in ChadCounting yet. Shame. Start counting!")
             await interaction.response.send_message(embed=embed)
         except Exception as e:
             await command_exception(interaction, e)
 #endregion
 
-bot.run(TOKEN)
+#region APIs
+def discordbotlist_api_authorization_header():
+    """Base headers for the Discordbotlist API"""
+    return {
+        "Authorization": f"Bot {DISCORDBOTLIST_TOKEN}",
+        "Content-Type": "application/json"
+    }
+
+def generic_api_authorization_header(token):
+    """Base headers for the Top.GG API."""
+    return {
+        "Authorization": token,
+        "Content-Type": "application/json"
+    }
+
+def push_commands_to_discordbotlist():
+    """Sends the bot's commands via the API."""
+    if check_dev_disable_apis(push_commands_to_discordbotlist.__name__): return
+    url = f"{api_discordbotslist}/commands"
+    headers = discordbotlist_api_authorization_header()
+    # Convert list of commands to json-serializable and API-understandable format
+    commands_list = []
+    for command in get_all_commands(bot):
+        commands_list.append({"name": command.qualified_name, "description": command.description})
+    response = requests.post(url, headers=headers, json=commands_list)
+    print(f"[{datetime.now()}] {push_commands_to_discordbotlist.__name__}: API response {response.status_code}.")
+
+def push_guilds_count_to_all_bot_websites():
+    """Pushes the current guild count to all bot websites configured."""
+    if check_dev_disable_apis(push_guilds_count_to_all_bot_websites.__name__): return
+    discordbotlist_headers = discordbotlist_api_authorization_header()
+    topgg_headers = generic_api_authorization_header(TOPGG_TOKEN)
+    discords_headers = generic_api_authorization_header(DISCORDS_TOKEN)
+    discordbotsgg_headers = generic_api_authorization_header(DISCORDBOTSGG_TOKEN)
+    push_guilds_count_to_bot_website(f"{api_discordbotslist}/stats", "guilds", discordbotlist_headers)
+    push_guilds_count_to_bot_website(f"{api_topgg}/stats", "server_count", topgg_headers)
+    push_guilds_count_to_bot_website(api_discords, "server_count", discords_headers)
+    push_guilds_count_to_bot_website(f"{api_discordbotsgg}/stats", "guildCount", discordbotsgg_headers)
+
+def push_guilds_count_to_bot_website(url, payload_string, headers):
+    """Sends the number of guilds via the API."""
+    payload = {payload_string: len(bot.guilds)}
+    response = requests.post(url, headers=headers, json=payload)
+    print(f"[{datetime.now()}] {push_guilds_count_to_bot_website.__name__}: {url} API response {response.status_code}.")
+#endregion
+
+bot.run(PROD_TOKEN)
 # Coded by https://github.com/Gitfoe