Enso-Bot/cogs/info.py

# 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, Union

from discord import Embed, Role
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, MissingRequiredArgument, \
    BadUnionArgument
from discord.ext.commands import command
from psutil import Process, virtual_memory

from bot.libs.paginator import SimpleMenu

# 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 get_region(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 add_perms(embed, list):
    """Add all the permission in the list to embed fields"""

    i = 0
    while i < len(list):
        embed.add_field(name=str(list[i].split(":")[0]).strip(),
                        value=f"<{list[i].split('<')[1]}",
                        inline=True)
        i += 1

    return embed


def detect_perms(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)


async def line_count():
    """Getting the line count of the project"""

    code = 0
    comments = 0
    blank = 0
    file_amount = 0
    ENV = "venv"

    for path, _, files in os.walk("."):
        if ".local" in path:
            continue
        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 f"Code: {code}\n" \
           f"Commentary: {comments}\n" \
           f"Blank: {blank}\n" \
           f"Total: {total}\n" \
           f"Files: {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 self.bot.generate_embed(ctx, desc=f"Pong! **{round(self.bot.latency * 1000)}ms**")

    @command(name="roleinfo", aliases=["ri"])
    @cooldown(1, 1, BucketType.user)
    @guild_only()
    async def role_info(self, ctx, role: Role):
        """Retrieve information about any role!"""

        # Returns the permissions that the user has within the guild
        filtered = filter(lambda x: x[1], role.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, detect_perms(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

        if len(role.members) > 30:
            # Retrieve the length of the members within the role
            length = len(role.members) - 30

            # Store the first 30 members in a string called "roles" (highest to lowest)
            member = f"{' **|** '.join(map(str, (member.mention for member in list(reversed(role.members))[:30])))} and **{length}** more"

        else:
            # Display all members within the roles as it is lower than 30
            member = f"{' **|** '.join(map(str, (member.mention for member in list(reversed(role.members)))))}"

        # Accounting for the edge case the role has no members
        members = "No Members In Role" if member == "" else member

        # Using emotes to represent bools
        mentionable = self.bot.tick if role.mention else self.bot.cross
        hoisted = self.bot.tick if role.hoist else self.bot.cross
        managed = self.bot.tick if role.managed else self.bot.cross

        # Description of the embed
        desc = f"{role.mention} " \
               f"**<-- Colour:** {str(role.colour)} | **Position:** {role.position}"

        # Set up Embed
        embed = Embed(title=f"{role.name}",
                      description=desc,
                      colour=role.colour,
                      timestamp=datetime.datetime.utcnow())
        embed.set_thumbnail(url=ctx.guild.icon_url)
        embed.set_footer(text=f"ID: {role.id}")

        # Setting up fields
        fields = [
            ("Creation At", role.created_at.strftime("%a, %b %d, %Y\n%I:%M:%S %p"), True),

            (f"Misc",
             f"\nMentionable?: {mentionable}" +
             f"\nHoisted?: {hoisted}" +
             f"\nManaged?: {managed}", True),

            (f"Members ({len(role.members)})",
             f"\nHumans: {len(list(filter(lambda m: not m.bot, role.members)))}" +
             f"\nBots: {len(list(filter(lambda m: m.bot, role.members)))}", True),

            ("List of Members", members, False),
            ("Key Permissions", permissions, 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="permissions", aliases=["perms"], usage="`[Member|Role]`")
    @cooldown(1, 1, BucketType.user)
    @guild_only()
    @bot_has_permissions(embed_links=True, add_reactions=True)
    async def perms(self, ctx, *, item: Optional[Union[Member, Role]]):
        """View all permissions for any Member/Role!"""

        item = item if item else ctx.author

        if isinstance(item, Member):
            # Iterating through list of perms
            perms = [f"{perm.title().replace('_', ' ')}: {self.bot.tick if value else self.bot.cross}" for perm, value
                     in item.guild_permissions]

        else:
            # Iterating through list of perms
            perms = [f"{perm.title().replace('_', ' ')}: {self.bot.tick if value else self.bot.cross}" for perm, value
                     in item.permissions]

        middle = len(perms) // 2
        f_half = perms[:middle]
        s_half = perms[middle:]

        first_page = Embed(description=f"**Item:** {item}",
                           colour=self.bot.admin_colour,
                           timestamp=datetime.datetime.utcnow())
        first_page.set_footer(text=f"ID: {item.id}")

        second_page = Embed(description=f"**Item:** {item}",
                            colour=self.bot.admin_colour,
                            timestamp=datetime.datetime.utcnow())
        second_page.set_footer(text=f"ID: {item.id}")

        # Add permissions to both of the embeds
        first = add_perms(first_page, f_half)
        second = add_perms(second_page, s_half)

        # Get the permissions of the channel
        perms = ctx.guild.me.permissions_in(ctx.message.channel)

        menu = SimpleMenu(0, item, perms, [first, second], self)
        await menu.start(ctx)

    @command(name="rolelist", aliases=["rl"])
    @cooldown(1, 1, BucketType.user)
    @guild_only()
    async def role_list(self, ctx):
        """Retrieve list of all roles in the server!"""

        # More readable name
        guild_roles = ctx.guild.roles

        if len(guild_roles) > 50:
            # Retrieve the length of the remaining roles
            length = len(guild_roles) - 50

            # Store the first 50 roles in a string called "roles" (highest to lowest)
            role = f"{' **|** '.join(map(str, (role.mention for role in list(reversed(guild_roles))[:50])))} 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(guild_roles[1:])))))}"

        # Accounting for the edge case where the user has no roles to be displayed
        roles = "Guild Has No Roles" if role == "" else role

        embed = Embed(title=f"{ctx.guild}'s Roles({len(ctx.guild.roles)})",
                      description=roles,
                      color=self.bot.random_colour(),
                      timestamp=datetime.datetime.utcnow())
        embed.set_footer(text=f"Guild ID: {ctx.guild.id}", icon_url=ctx.guild.icon_url)

        await ctx.send(embed=embed)

    @command(name="userinfo")
    @cooldown(1, 1, 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, detect_perms(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=userAvatar)

        # Define fields to be added into the embed
        embed_fields = [("Name", member.mention, True),
                        ("Tag", member.name, True),
                        ("Discrim", f"#{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=["si", "guildinfo", "gi"])
    @cooldown(1, 1, BucketType.user)
    @guild_only()
    @bot_has_permissions(embed_links=True)
    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=guild_icon)

        # Get the list of banned users from the server
        bans = len(await ctx.guild.bans()) if perms.ban_members else "No Perms <:xMark:746834944629932032>"

        # Get the list of invites created for the server
        invites = len(await ctx.guild.invites()) if perms.manage_guild else "No Perms <:xMark:746834944629932032>"

        # 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", get_region(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"])
    @cooldown(1, 1, BucketType.user)
    @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 information about the channel
        channel = ctx.channel if not channel else channel
        category = channel.category.name if channel.category else self.bot.cross
        perms_synced = self.bot.tick if channel.permissions_synced else self.bot.cross
        topic = channel.topic if channel.topic else self.bot.cross
        nsfw = self.bot.tick if channel.is_nsfw() else self.bot.cross

        # Set up Embed
        desc = f"**Guild:** {ctx.guild}" \
               f"\n**Category:** {category}" \
               f"\n**Topic:** {topic}"
        embed = Embed(title=f"Statistics For #{channel.name}",
                      description=desc,
                      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 = [("Position", channel.position, False),
                  ("Permissions Synced?", perms_synced, True),
                  ("Nsfw?", nsfw, True),
                  ("Creation At", channel.created_at.strftime("%a, %b %d, %Y\n%I:%M:%S %p"), 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="about")
    @cooldown(1, 1, BucketType.user)
    @bot_has_permissions(embed_links=True)
    async def checking_bot_stats(self, ctx):
        """Bot Statistics! (CPU/Mem Usage etc)"""

        stats = Embed(title=f"<:github:741000905364603010> Ensō~Chan {self.bot.version} 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=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 = f'{int(uptime_hours):01} Hour(s), {int(uptime_minutes):01} Minute(s), {int(uptime_seconds):01} Second(s)'

        # 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:747224674319990895> Python {python_version()} | <:discord:747224665553895544> Discord.py {discord_version}",
             False),

            ("<:discord:747224665553895544> 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",
             f"Guilds: {len(self.bot.guilds)}"
             f"\nChannels: {sum(list(channels))}"
             f"\nEmojis: {len(self.bot.emojis)}"
             f"\nCommands: {len(self.bot.commands)}"
             f"\nUsers: {len(self.bot.users):,}", True),

            ("Line Count", await line_count(), 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")
    @cooldown(1, 1, BucketType.user)
    @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=ctx.author.avatar_url)

        await ctx.send(embed=embed)

    @perms.error
    async def mlsetup_command_error(self, ctx, exc):
        """Catching error if User or Channel is not recognised"""

        if isinstance(exc, BadUnionArgument):
            text = "**User | Role** Not Detected... Aborting Process"
            await self.bot.generate_embed(ctx, desc=text)
        if isinstance(exc, MissingRequiredArgument):
            text = "Required Argument(s) Missing!" \
                   f"\nUse **{ctx.prefix}help** to find how to use **{ctx.command}**"
            await self.bot.generate_embed(ctx, desc=text)


def setup(bot):
    bot.add_cog(Info(bot))