mirror of https://github.com/sgoudham/Enso-Bot.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
447 lines
17 KiB
Python
447 lines
17 KiB
Python
# Ensō~Chan - A Multi Purpose Discord Bot That Has Everything Your Server Needs!
|
|
# Copyright (C) 2020 Goudham Suresh
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
import datetime
|
|
import os
|
|
import pathlib
|
|
import string
|
|
from asyncio.subprocess import Process
|
|
from platform import python_version
|
|
from time import time
|
|
from typing import Optional
|
|
|
|
from discord import Embed
|
|
from discord import Member, TextChannel
|
|
from discord import __version__ as discord_version
|
|
from discord.ext.commands import BucketType, cooldown, bot_has_permissions, guild_only, Cog
|
|
from discord.ext.commands import command
|
|
from psutil import Process, virtual_memory
|
|
|
|
# Using forzenset
|
|
# Permissions to filter through
|
|
Perms = frozenset(
|
|
{
|
|
"create instant invite",
|
|
"add reactions",
|
|
"view audit log",
|
|
"priority speaker",
|
|
"stream",
|
|
"read messages",
|
|
"send messages",
|
|
"send tts messages",
|
|
"embed links",
|
|
"attach links",
|
|
"read message history",
|
|
"external emojis",
|
|
"view guild insights",
|
|
"connect",
|
|
"speak",
|
|
"use voice activation",
|
|
"change nickname"
|
|
}
|
|
)
|
|
|
|
region = {
|
|
"eu-central": ":flag_eu: Central Europe",
|
|
"europe": ":flag_eu: Central Europe",
|
|
"singapore": ":flag_sg: Singapore",
|
|
"india": ":flag_in: India",
|
|
"japan": ":flag_jp: Japan",
|
|
"us-central": ":flag_us: U.S. Central",
|
|
"sydney": ":flag_au: Sydney",
|
|
"us-east": ":flag_us: U.S. East",
|
|
"us-south": ":flag_us: U.S. South",
|
|
"us-west": ":flag_us: U.S. West",
|
|
"eu-west": ":flag_eu: Western Europe",
|
|
"vip-us-east": ":flag_us: VIP U.S. East",
|
|
"london": ":flag_gb: London",
|
|
"amsterdam": ":flag_nl: Amsterdam",
|
|
"hongkong": ":flag_hk: Hong Kong",
|
|
"russia": ":flag_ru: Russia",
|
|
"southafrica": ":flag_za: South Africa",
|
|
"brazil": ":flag_br: Brazil"
|
|
}
|
|
|
|
|
|
def getRegion(disc_region, region_dict):
|
|
"""Return Nicer Looking Region String"""
|
|
|
|
for key in region_dict:
|
|
if key == disc_region:
|
|
return region_dict[key]
|
|
else:
|
|
pass
|
|
|
|
|
|
def detectPermissions(message, fset):
|
|
"""Filter out permissions that are not important"""
|
|
|
|
# Split the message individual permissions
|
|
message = message.split(",")
|
|
|
|
# Filter the permission out if it's in the frozenset
|
|
filtered = filter(lambda perm: perm not in fset, message)
|
|
return ", ".join(filtered)
|
|
|
|
|
|
def lineCount():
|
|
"""Getting the line count of the project"""
|
|
|
|
code = 0
|
|
comments = 0
|
|
blank = 0
|
|
file_amount = 0
|
|
ENV = "venv"
|
|
|
|
for path, _, files in os.walk("."):
|
|
for name in files:
|
|
file_dir = str(pathlib.PurePath(path, name))
|
|
# Ignoring the venv directory
|
|
if not name.endswith(".py") or ENV in file_dir:
|
|
continue
|
|
file_amount += 1
|
|
with open(file_dir, "r", encoding="utf-8") as file:
|
|
for line in file:
|
|
if line.strip().startswith("#"):
|
|
comments += 1
|
|
elif not line.strip():
|
|
blank += 1
|
|
else:
|
|
code += 1
|
|
|
|
# Adding up the total lines of code
|
|
total = comments + blank + code
|
|
|
|
return "Code: {}\n" \
|
|
"Commentary: {}\n" \
|
|
"Blank: {}\n" \
|
|
"Total: {}\n" \
|
|
"Files: {}".format(code, comments, blank, total, file_amount)
|
|
|
|
|
|
class Info(Cog):
|
|
"""(User/Server/Bot etc) Information!"""
|
|
|
|
def __init__(self, bot):
|
|
self.bot = bot
|
|
|
|
@Cog.listener()
|
|
async def on_ready(self):
|
|
"""Printing out that Cog is ready on startup"""
|
|
print(f"{self.__class__.__name__} Cog has been loaded\n-----")
|
|
|
|
@command(name="ping")
|
|
async def ping(self, ctx):
|
|
"""Latency of the Bot (ms)"""
|
|
|
|
await ctx.send(f"Pong! `{round(self.bot.latency * 1000)}ms`")
|
|
|
|
@command(name="userinfo")
|
|
@cooldown(1, 5, BucketType.user)
|
|
@guild_only()
|
|
@bot_has_permissions(embed_links=True)
|
|
async def user_info(self, ctx, member: Optional[Member] = None):
|
|
"""User Information! (Created At/Joined/Roles etc)"""
|
|
|
|
# Use member when mentioned
|
|
# Use author if no member is mentioned
|
|
member = ctx.author if not member else member
|
|
|
|
# Get the member avatar
|
|
userAvatar = member.avatar_url
|
|
|
|
# Check if user roles is greater than 20
|
|
if len(member.roles) > 20:
|
|
# Retrieve the length of the remaining roles
|
|
length = len(member.roles) - 20
|
|
|
|
# Store the first 20 roles in a string called "roles" (highest to lowest)
|
|
role = f"{' '.join(map(str, (role.mention for role in list(reversed(member.roles))[:20])))} and **{length}** more"
|
|
|
|
else:
|
|
# Display all roles as it is lower than 20
|
|
role = f"{' '.join(map(str, (role.mention for role in list(reversed(member.roles[1:])))))}"
|
|
|
|
# Accounting for the edge case where the user has no roles to be displayed
|
|
roles = "No Roles" if role == "" else role
|
|
|
|
# Returns the permissions that the user has within the guild
|
|
filtered = filter(lambda x: x[1], member.guild_permissions)
|
|
# Replace all "_" with " " in each item and join them together
|
|
perms = ",".join(map(lambda x: x[0].replace("_", " "), filtered))
|
|
|
|
# Capitalise every word in the array and filter out the permissions that are defined within the frozenset
|
|
permission = string.capwords("".join(map(str, detectPermissions(perms, Perms))))
|
|
|
|
# Accounting for the edge case where the user has no key permissions to be displayed
|
|
permissions = "No Key Permissions" if permission == "" else permission
|
|
|
|
# Set up the embed to display everything about the user
|
|
embed = Embed(
|
|
title=f"**User Information**",
|
|
colour=self.bot.random_colour(),
|
|
timestamp=datetime.datetime.utcnow()
|
|
)
|
|
embed.set_thumbnail(url=userAvatar)
|
|
embed.set_footer(text=f"ID: {member.id}", icon_url='{}'.format(userAvatar))
|
|
|
|
# Define fields to be added into the embed
|
|
embed_fields = [("Name", member.mention, True),
|
|
("Tag", member.name, True),
|
|
("Discrim", "#" + member.discriminator, True),
|
|
("Registered", member.created_at.strftime("%a, %b %d, %Y\n%I:%M:%S %p"), True),
|
|
("Joined", member.joined_at.strftime("%a, %b %d, %Y\n%I:%M:%S %p"), True),
|
|
("Top Role", member.top_role.mention, False),
|
|
("Roles", roles, False),
|
|
("Key Permissions", permissions, False),
|
|
("Status", str(member.status).title(), True),
|
|
("Boosting Server", bool(member.premium_since), True),
|
|
("Bot", member.bot, True)]
|
|
|
|
# Add fields to the embed
|
|
for name, value, inline in embed_fields:
|
|
embed.add_field(name=name, value=value, inline=inline)
|
|
|
|
# Send the embed to the channel that the command was triggered in
|
|
await ctx.send(embed=embed)
|
|
|
|
@command(name="serverinfo", aliases=["guildinfo"])
|
|
@guild_only()
|
|
@bot_has_permissions(embed_links=True)
|
|
@cooldown(1, 5, BucketType.user)
|
|
async def server_info(self, ctx):
|
|
"""Guild Information! (Owner/Roles/Emojis etc)"""
|
|
|
|
# Define guild icon and id
|
|
guild_icon = ctx.guild.icon_url
|
|
guild_id = ctx.guild.id
|
|
|
|
# Getting permissions of the bot within the channel
|
|
perms = ctx.guild.me.permissions_in(ctx.message.channel)
|
|
|
|
# Retrieve the top role of the guild
|
|
top_role = ctx.guild.roles[-1]
|
|
|
|
# Check if the amount of roles is above 20
|
|
if len(ctx.guild.roles) > 20:
|
|
# Retrieve the length of the remaining roles
|
|
length = len(ctx.guild.roles) - 20
|
|
|
|
# Store the first 20 roles in a string called "roles" (highest to lowest)
|
|
role_string = f"{' '.join(map(str, (role.mention for role in list(reversed(ctx.guild.roles))[:20])))} and **{length}** more"
|
|
|
|
else:
|
|
# Display all roles as it is lower than 20
|
|
role_string = f"{' '.join(map(str, (role.mention for role in list(reversed(ctx.guild.roles[1:])))))}"
|
|
|
|
# Check if the list of emojis returned are greater than 20
|
|
if len(ctx.guild.emojis) > 20:
|
|
# Display the first 20 emojis with a length specified telling the user how many emojis were not shown
|
|
length = len(ctx.guild.emojis) - 20
|
|
|
|
# Store the first 20 emojis in a string
|
|
emojis = f"{' '.join(map(str, ctx.guild.emojis[:20]))} and **{length}** more..."
|
|
|
|
else:
|
|
# Display all the emojis in the server as it is less than 20
|
|
emojis = " ".join(map(str, ctx.guild.emojis))
|
|
|
|
emojis = "No Emoji's Available" if emojis == "" else emojis
|
|
|
|
# Defining a dictionary of the statuses
|
|
member_status = {
|
|
"online": 0,
|
|
"idle": 0,
|
|
"dnd": 0,
|
|
"offline": 0
|
|
}
|
|
|
|
# Iterating over the members and then storing the numbers in the dictionary
|
|
for m in ctx.guild.members:
|
|
member_status[str(m.status)] += 1
|
|
|
|
# Storing the statuses in an array
|
|
statuses = [member_status["online"],
|
|
member_status["idle"],
|
|
member_status["dnd"],
|
|
member_status["offline"]]
|
|
|
|
# Set up embed to display all the server information
|
|
embed = Embed(title="**Server Information**",
|
|
colour=self.bot.random_colour(),
|
|
timestamp=datetime.datetime.utcnow())
|
|
embed.set_thumbnail(url=guild_icon)
|
|
embed.set_footer(text=f"ID: {guild_id}", icon_url='{}'.format(guild_icon))
|
|
|
|
# Get the list of banned users from the server
|
|
bans = len(await ctx.guild.bans()) if perms.ban_members else "N/A"
|
|
|
|
# Get the list of invites created for the server
|
|
invites = len(await ctx.guild.invites()) if perms.manage_guild else "N/A"
|
|
|
|
# Define fields to be added into the embed
|
|
fields = [("Owner", ctx.guild.owner.mention, True),
|
|
("Created", ctx.guild.created_at.strftime("%a, %b %d, %Y\n%I:%M:%S %p"), False),
|
|
("Region", getRegion(str(ctx.guild.region), region), False),
|
|
("Statuses", f"🟢 {statuses[0]} \n🟠 {statuses[1]} \n🔴 {statuses[2]} \n⚪ {statuses[3]}", False),
|
|
|
|
(f"Members ({len(ctx.guild.members)})",
|
|
f"\nHumans: {len(list(filter(lambda m: not m.bot, ctx.guild.members)))}" +
|
|
f"\nBots: {len(list(filter(lambda m: m.bot, ctx.guild.members)))}" +
|
|
f"\nBanned: {bans}", True),
|
|
|
|
(f"Channels ({len(ctx.guild.channels)})",
|
|
f"\nText: {len(ctx.guild.text_channels)}" +
|
|
f"\nVoice: {len(ctx.guild.voice_channels)}" +
|
|
f"\nCategories: {len(ctx.guild.categories)}", True),
|
|
|
|
("Misc",
|
|
f"Invites: {invites}" +
|
|
f"\nVerif Level: {ctx.guild.verification_level.name.capitalize()}" +
|
|
f"\nNitro Boosters: {len(ctx.guild.premium_subscribers)}", True),
|
|
("Top Role", top_role.mention, False),
|
|
(f"Roles ({len(ctx.guild.roles)})", role_string, True),
|
|
(f"Emojis ({len(ctx.guild.emojis)})", emojis, False)]
|
|
|
|
# Add fields to the embed
|
|
for name, value, inline in fields:
|
|
embed.add_field(name=name, value=value, inline=inline)
|
|
|
|
await ctx.send(embed=embed)
|
|
|
|
@command(name="channelinfo", aliases=["chinfo"])
|
|
@guild_only()
|
|
@bot_has_permissions(embed_links=True)
|
|
async def channel_info(self, ctx, channel: Optional[TextChannel] = None):
|
|
"""Channel Statistics! (Category/Created At etc)"""
|
|
|
|
# Get the channel that the user is in
|
|
channel = ctx.channel if not channel else channel
|
|
|
|
# Set up Embed
|
|
embed = Embed(title=f"Statistics For #{channel.name}",
|
|
description=f"{'Category: {}'.format(channel.category.name) if channel.category else 'N/A'}",
|
|
timestamp=datetime.datetime.utcnow(),
|
|
colour=self.bot.random_colour())
|
|
embed.set_thumbnail(url=ctx.guild.icon_url)
|
|
embed.set_footer(text=f"ID: {channel.id}")
|
|
|
|
# Setting up fields
|
|
fields = [
|
|
("Guild", ctx.guild.name, True),
|
|
("Creation At", channel.created_at.strftime("%a, %b %d, %Y\n%I:%M:%S %p"), True),
|
|
("Topic", f"{channel.topic if channel.topic else 'No Topic'}", True),
|
|
("Permissions Synced?", channel.permissions_synced, True),
|
|
("Position", channel.position, True),
|
|
("NSFW?", channel.is_nsfw(), True)
|
|
]
|
|
|
|
# Add fields to the embed
|
|
for name, value, inline in fields:
|
|
embed.add_field(name=name, value=value, inline=inline)
|
|
|
|
await ctx.send(embed=embed)
|
|
|
|
@command(name="about")
|
|
@bot_has_permissions(embed_links=True)
|
|
async def checking_bot_stats(self, ctx):
|
|
"""Bot Statistics! (CPU/Mem Usage etc)"""
|
|
|
|
stats = Embed(title="<:github:741000905364603010> Ensō~Chan v1.7.2 Statistics",
|
|
url="https://github.com/sgoudham/Enso-Bot",
|
|
colour=self.bot.admin_colour,
|
|
timestamp=datetime.datetime.utcnow())
|
|
stats.set_thumbnail(url=self.bot.user.avatar_url)
|
|
stats.set_footer(text=f"Requested by {ctx.author}", icon_url='{}'.format(ctx.author.avatar_url))
|
|
|
|
# Grabbing technical statistics of the bot
|
|
proc = Process()
|
|
with proc.oneshot():
|
|
uptime = datetime.timedelta(seconds=time() - proc.create_time())
|
|
mem_total = virtual_memory().total / (1024 ** 2)
|
|
mem_of_total = proc.memory_percent()
|
|
mem_usage = mem_total * (mem_of_total / 100)
|
|
|
|
uptime_hours, uptime_remainder = divmod(uptime.seconds, 3600)
|
|
uptime_minutes, uptime_seconds = divmod(uptime_remainder, 60)
|
|
frmt_uptime = '{:01} Hour(s), {:01} Minute(s), {:01} Second(s)'.format(int(uptime_hours), int(uptime_minutes),
|
|
int(uptime_seconds))
|
|
|
|
# Grabbing total number of channels across all guilds in which the bot is present in
|
|
channels = map(lambda m: len(m.channels), self.bot.guilds)
|
|
|
|
# Setting up fields
|
|
fields = [
|
|
("Developer", f"{self.bot.hammyMention} | Hamothy#5619", False),
|
|
|
|
("Language | Library",
|
|
f"<:python:661908544739737611> Python {python_version()} | <:discord:314003252830011395> Discord.py {discord_version}",
|
|
False),
|
|
|
|
("<:discord:314003252830011395> Support Server",
|
|
"[Here!](https://discord.com/invite/SZ5nexg)", True),
|
|
|
|
("<:invite:740998357643952139> Invite Link",
|
|
"[Here!](https://discord.bots.gg/bots/716701699145728094)", True),
|
|
|
|
("❗ Current Prefix", ctx.prefix, True),
|
|
|
|
("Discord Stats",
|
|
"Guilds: {}"
|
|
"\nChannels: {}"
|
|
"\nEmojis: {}"
|
|
"\nCommands: {}"
|
|
"\nUsers: {:,}".format(len(self.bot.guilds), sum(list(channels)), len(self.bot.emojis),
|
|
len(self.bot.commands),
|
|
len(self.bot.users)), True),
|
|
|
|
("Line Count", lineCount(), True),
|
|
("Uptime", frmt_uptime, False),
|
|
("Memory Usage", f"{mem_usage:,.2f} / {mem_total:,.2f} MiB ({mem_of_total:.2f}%)", False)]
|
|
|
|
# Add fields to the embed
|
|
for name, value, inline in fields:
|
|
stats.add_field(name=name, value=value, inline=inline)
|
|
|
|
await ctx.send(embed=stats)
|
|
|
|
@command(name="avatar")
|
|
@bot_has_permissions(embed_links=True)
|
|
async def get_user_avatar(self, ctx, member: Optional[Member] = None):
|
|
"""
|
|
Displaying Member's Avatar
|
|
Member can be mentioned and their avatar will be displayed
|
|
"""
|
|
|
|
# Get member mentioned or set to author
|
|
member = ctx.author if not member else member
|
|
|
|
# Get the member avatar
|
|
userAvatar = str(member.avatar_url)
|
|
|
|
embed = Embed(title=f"{member}'s Avatar",
|
|
url=userAvatar,
|
|
colour=self.bot.admin_colour,
|
|
timestamp=datetime.datetime.utcnow())
|
|
embed.set_image(url=userAvatar)
|
|
embed.set_footer(text=f"Requested by {ctx.author}", icon_url='{}'.format(ctx.author.avatar_url))
|
|
|
|
await ctx.send(embed=embed)
|
|
|
|
|
|
def setup(bot):
|
|
bot.add_cog(Info(bot))
|