Major rewrite, Added optional commands for displaying V+ config settings

2 files changed, 392 insertions, 0 deletions

diff --git a/code/botcmds/helpcmds.py b/code/botcmds/helpcmds.py
new file mode 100644
index 0000000..10bc239
--- /dev/null
+++ b/code/botcmds/helpcmds.py
@@ -0,0 +1,134 @@
+import discord, config
+from discord.ext import commands
+from discord.errors import Forbidden
+
+"""This custom help command is a perfect replacement for the default one on any Discord Bot written in Discord.py!
+
+Original concept by Jared Newsom (AKA Jared M.F.)
+[Deleted] https://gist.github.com/StudioMFTechnologies/ad41bfd32b2379ccffe90b0e34128b8b
+Rewritten and optimized by github.com/nonchris
+https://gist.github.com/nonchris/1c7060a14a9d94e7929aa2ef14c41bc2
+Edited by stolenvw for Stolenvw ValPlusBot
+"""
+
+
+async def send_embed(ctx, embed):
+    """
+    Function that handles the sending of embeds
+    -> Takes context and embed to send
+    - tries to send embed in channel
+    - tries to send normal message when that fails
+    - tries to send embed private with information abot missing permissions
+    If this all fails: https://youtu.be/dQw4w9WgXcQ
+    """
+    try:
+        await ctx.send(embed=embed)
+    except Forbidden:
+        try:
+            await ctx.send("Hey, seems like I can't send embeds. Please check my permissions :)")
+        except Forbidden:
+            await ctx.author.send(
+                f"Hey, seems like I can't send any message in {ctx.channel.name} on {ctx.guild.name}\n"
+                f"May you inform the server team about this issue? :slight_smile: ", embed=embed)
+
+
+class Help(commands.Cog):
+    """
+    Sends this help message
+    """
+
+    def __init__(self, bot):
+        self.bot = bot
+        self.bot.remove_command("help")
+
+    @commands.command()
+    # @commands.bot_has_permissions(add_reactions=True,embed_links=True)
+    async def help(self, ctx, *input):
+        """Shows all modules of that bot"""
+
+	    # !SET THOSE VARIABLES TO MAKE THE COG FUNCTIONAL!
+        prefix = config.BOT_PREFIX
+        version =  "v1.0.0"
+
+        # checks if cog parameter was given
+        # if not: sending all modules and commands not associated with a cog
+        if not input:
+            # starting to build embed
+            emb = discord.Embed(title='Valheim Plus Discord Bot', url="https://github.com/stolenvw/ValheimPlus-Discord_Bot", color=discord.Color.blue(),
+                                description=f'Use `{prefix}help <module>` to gain more information about that module '
+                                            f'\n')
+
+            # iterating trough cogs, gathering descriptions
+            cogs_desc = ''
+            for cog in self.bot.cogs:
+                if cog != "BotSQL" and cog != "Admin":
+                    cogs_desc += f'`{cog}` {self.bot.cogs[cog].__doc__}\n'
+
+            # adding 'list' of cogs to embed
+            emb.add_field(name='Modules', value=cogs_desc, inline=False)
+
+            # integrating trough uncategorized commands
+            commands_desc = ''
+            for command in self.bot.walk_commands():
+                # if cog not in a cog
+                # listing command if cog name is None and command isn't hidden
+                if not command.cog_name and not command.hidden:
+                    commands_desc += f'{command.name} - {command.help}\n'
+
+            # adding those commands to embed
+            if commands_desc:
+                emb.add_field(name='Not belonging to a module', value=commands_desc, inline=False)
+
+            emb.set_footer(text=f"Stolenvw ValPlusBot {version}")
+
+        # block called when one cog-name is given
+        # trying to find matching cog and it's commands
+        elif len(input) == 1:
+
+            # iterating trough cogs
+            for cog in self.bot.cogs:
+                # check if cog is the matching one
+                if cog.lower() == input[0].lower():
+
+                    # making title - getting description from doc-string below class
+                    emb = discord.Embed(title=f'{cog} - Commands', description=self.bot.cogs[cog].__doc__,
+                                        color=discord.Color.green())
+
+                    # getting commands from cog
+                    for command in self.bot.get_cog(cog).get_commands():
+                        # if cog is not hidden
+                        if not command.hidden:
+                            if not command.usage:
+                                emb.add_field(name=f"`{prefix}{command.name}`", value=command.help, inline=False)
+                            else:
+                                emb.add_field(name=f"`{prefix}{command.name} {command.usage}`", value=command.help, inline=False)
+                    # found cog - breaking loop
+                    break
+
+            # if input not found
+            # yes, for-loops have an else statement, it's called when no 'break' was issued
+            else:
+                emb = discord.Embed(title="What's that?!",
+                                    description=f"I've never heard from a module called `{input[0]}` before",
+                                    color=discord.Color.orange())
+
+        # too many cogs requested - only one at a time allowed
+        elif len(input) > 1:
+            emb = discord.Embed(title="That's too much.",
+                                description="Please request only one module at once",
+                                color=discord.Color.orange())
+
+        else:
+            emb = discord.Embed(title="It's a magical place.",
+                                description="I don't know how you got here. But I didn't see this coming at all.\n"
+                                            "Would you please be so kind to report that issue to me on github?\n"
+                                            "https://github.com/nonchris/discord-fury/issues\n"
+                                            "Thank you! ~Chris",
+                                color=discord.Color.red())
+
+        # sending reply embed using our own function defined above
+        await send_embed(ctx, emb)
+
+
+def setup(bot):
+    bot.add_cog(Help(bot))
diff --git a/code/botcmds/maincmd.py b/code/botcmds/maincmd.py
new file mode 100644
index 0000000..e1e2000
--- /dev/null
+++ b/code/botcmds/maincmd.py
@@ -0,0 +1,258 @@
+import discord, typing, config, time, mysql.connector
+from discord.ext import commands
+from datetime import datetime, timedelta
+from matplotlib import pyplot as plt
+import matplotlib.dates as md
+import matplotlib.ticker as ticker
+import matplotlib.spines as ms
+import pandas as pd
+
+class Main(commands.Cog):
+    """
+    Main bot commands
+    """
+
+    def __init__(self, bot):
+        self.bot = bot
+        self.mydb = mysql.connector.connect(
+            host=config.SQL_HOST,
+            user=config.SQL_USER,
+            password=config.SQL_PASS,
+            database=config.SQL_DATABASE,
+            port=config.SQL_PORT,
+            )
+
+    @commands.command(name="deaths",
+                      brief="Deaths leaderboard",
+                      help="Shows a top 5 leaderboard of players with the most deaths. \n Available: 1-10 (default: 5)",
+                      usage="<n>",
+                      )
+    async def leaderboards(self, ctx, arg: typing.Optional[str] = '5'):
+        ldrembed = discord.Embed(title=":skull_crossbones: __Death Leaderboards (top " + arg + ")__ :skull_crossbones:", color=0xFFC02C)
+        botsql = self.bot.get_cog('BotSQL')
+        mycursor = await botsql.get_cursor()
+        sql = """SELECT user, deaths FROM players WHERE deaths > 0 ORDER BY deaths DESC LIMIT %s""" % (arg)
+        mycursor.execute(sql)
+        Info = mycursor.fetchall()
+        row_count = mycursor.rowcount
+        l = 1
+        for ind in Info:
+            grammarnazi = 'deaths'
+            leader = ''
+            pdname = ind[0]
+            pddeath = ind[1]
+            if pddeath == 1 :
+                grammarnazi = 'death'
+            if l == 1:
+                leader = ':crown:'
+            ldrembed.add_field(name="{} {}".format(pdname,leader),
+                               value='{} {}'.format(pddeath,grammarnazi),
+                               inline=False)
+            l += 1
+        mycursor.close()
+        await ctx.send(embed=ldrembed)
+
+    @commands.command(name="stats",
+                      brief="Graph of connected players",
+                      help="Plots a graph of connected players over the last X hours.\n Available args: 24, 12, w (default: 24)",
+                      usage="<arg>",
+                      )
+    async def gen_plot(self, ctx, tmf: typing.Optional[str] = '24'):
+        user_range = 0
+        if tmf.lower() in ['w', 'week', 'weeks']:
+            user_range = 168 - 1
+            tlookup = int(time.time()) - 604800
+            interval = 24
+            date_format = '%m/%d'
+            timedo = 'week'
+            description = 'Players online in the past ' + timedo + ':'
+        elif tmf.lower() in ['12', '12hrs', '12h', '12hr']:
+            user_range = 12 - 0.15
+            tlookup = int(time.time()) - 43200
+            interval = 1
+            date_format = '%H'
+            timedo = '12hrs'
+            description = 'Players online in the past ' + timedo + ':'
+        else:
+            user_range = 24 - 0.30
+            tlookup = int(time.time()) - 86400
+            interval = 2
+            date_format = '%H'
+            timedo = '24hrs'
+            description = 'Players online in the past ' + timedo + ':'
+
+        #Get data from mysql
+        botsql = self.bot.get_cog('BotSQL')
+        mycursor = await botsql.get_cursor()
+        mycursor.close()
+        sqls = """SELECT date, users FROM serverstats WHERE timestamp BETWEEN '%s' AND '%s'""" % (tlookup, int(time.time()))
+        df = pd.read_sql(sqls, self.mydb, parse_dates=['date'])
+        lastday = datetime.now() - timedelta(hours = user_range)
+
+        # Plot formatting / styling matplotlib
+        plt.style.use('seaborn-pastel')
+        plt.minorticks_off()
+        fig, ax = plt.subplots()
+        ax.grid(b=True, alpha=0.2)
+        ax.set_xlim(lastday, datetime.now())
+        # ax.set_ylim(0, 10) Not sure about this one yet
+        for axis in [ax.xaxis, ax.yaxis]:
+            axis.set_major_locator(ticker.MaxNLocator(integer=True))
+        ax.xaxis.set_major_formatter(md.DateFormatter(date_format))
+        ax.xaxis.set_major_locator(md.HourLocator(interval=interval))
+        for spine in ax.spines.values():
+            spine.set_visible(False)
+        for tick in ax.get_xticklabels():
+            tick.set_color('gray')
+        for tick in ax.get_yticklabels():
+            tick.set_color('gray')
+
+        #Plot and rasterize figure
+        plt.gcf().set_size_inches([5.5,3.0])
+        plt.plot(df['date'], df['users'], drawstyle='steps-post')
+        plt.tick_params(axis='both', which='both', bottom=False, left=False)
+        plt.margins(x=0,y=0,tight=True)
+        plt.tight_layout()
+        fig.savefig('img/temp.png', transparent=True, pad_inches=0) # Save and upload Plot
+        image = discord.File('img/temp.png', filename='temp.png')
+        plt.close()
+        embed = discord.Embed(title=config.SERVER_NAME, description=description, colour=12320855)
+        embed.set_image(url='attachment://temp.png')
+        await ctx.send(file=image, embed=embed)
+
+    @commands.command(name="playerstats",
+                      brief="Player stats",
+                      help="Shows player stats on active monitored world.\n Arg= <Players Name>",
+                      usage="<arg>",
+                      )
+    async def playstats(self, ctx, arg):
+        botsql = self.bot.get_cog('BotSQL')
+        mycursor = await botsql.get_cursor()
+        sql = """SELECT user, deaths, startdate, playtime FROM players WHERE user = '%s'""" % (arg)
+        mycursor.execute(sql)
+        Info = mycursor.fetchall()
+        row_count = mycursor.rowcount
+        if row_count == 1:
+            Info=Info[0]
+            plsembed = discord.Embed(title=":bar_chart: __Player Stats For " + Info[0] + "__ :bar_chart:", color=0x4A90E2)
+            plsembed.add_field(name="Server Join Date:",
+                               value='{}'.format(Info[2]),
+                               inline=True)
+            plsembed.add_field(name="Play Time:",
+                              value=str(timedelta(seconds = Info[3])),
+                              inline=True)
+            plsembed.add_field(name="Deaths:",
+                              value=Info[1],
+                              inline=True)
+            await ctx.send(embed=plsembed)
+        else:
+            await ctx.send(content=':no_entry_sign: **' + arg + '** Not Found')
+        mycursor.close()
+
+    @commands.command(name="active",
+                      brief="Active players",
+                      help="Shows who is currently logged into the server and how long they have been on for.",
+                      )
+    async def actives(self, ctx):
+        botsql = self.bot.get_cog('BotSQL')
+        mycursor = await botsql.get_cursor()
+        sql = """SELECT user, jointime FROM players WHERE ingame = 1 ORDER BY jointime LIMIT 10"""
+        mycursor.execute(sql)
+        Info = mycursor.fetchall()
+        row_count = mycursor.rowcount
+        if row_count == 0:
+           await ctx.send(content=':globe_with_meridians: 0 Players Active')
+        else:
+             ldrembed = discord.Embed(title=":man_raising_hand: __Active Users__ :woman_raising_hand:", color=0x50E3C2)
+             EndTime = int(time.time())
+             for ind in Info:
+                 pname = ind[0]
+                 onfor = "Online For:"
+                 ponline = str(timedelta(seconds = EndTime - ind[1]))
+                 ldrembed.add_field(name="{}".format(pname),
+                                    value='{} {}'.format(onfor,ponline),
+                                    inline=False)
+             await ctx.send(embed=ldrembed)
+        mycursor.close()
+
+    @commands.command(name="version",
+                      brief="Server Versions",
+                      help="Shows current version of Valheim and Valheim Plus server is running.",
+                      )
+    async def versions(self, ctx):
+        botsql = self.bot.get_cog('BotSQL')
+        mycursor = await botsql.get_cursor()
+        sql = """SELECT serverversion, plusversion FROM exstats WHERE id = 1"""
+        mycursor.execute(sql)
+        Info = mycursor.fetchall()
+        row_count = mycursor.rowcount
+        if row_count == 1:
+            Info=Info[0]
+            sembed = discord.Embed(title="Server Versions", color=0x407500)
+            sembed.add_field(name="Valheim:",
+                               value='{}'.format(Info[0]),
+                               inline=True)
+            sembed.add_field(name="Valheim Plus:",
+                              value='{}'.format(Info[1]),
+                              inline=True)
+            await ctx.send(embed=sembed)
+        else:
+            await ctx.send(content=':no_entry_sign: Sorry no game version info found in the DB')
+        mycursor.close()
+
+    @commands.command(name="setstatus",
+                      brief="Server Versions",
+                      help="Set status message of the bot. \n Available arg: playing, watching, listening",
+                      usage='<arg> <"arg1">',
+                      hidden=True,
+                      )
+    @commands.is_owner()
+    async def setstatus(self, ctx, arg: typing.Optional[str] = '0', arg1: typing.Optional[str] = '1'):
+          if arg == "playing":
+             await self.bot.change_presence(activity=discord.Game(arg1))
+    #      elif arg == "streaming":
+    #         await bot.change_presence(activity=discord.Streaming(name=arg1, url=arg2))
+          elif arg == "watching":
+             await self.bot.change_presence(activity=discord.Activity(type=discord.ActivityType.watching, name=arg1))
+          elif arg == "listening":
+             await self.bot.change_presence(activity=discord.Activity(type=discord.ActivityType.listening, name=arg1))
+          else:
+               await ctx.channel.send('Usage: `{}setstatus <playing|watching|listening> "<Some activity>"`'.format(self.bot.command_prefix))
+
+    @commands.command(name="savestats",
+                      brief="Save stats",
+                      help="Shows how many zods where saved and time it took to save them.",
+                      hidden=True,
+                      )
+    @commands.is_owner()
+    async def savestats(self, ctx):
+        if config.EXSERVERINFO == True:
+            botsql = self.bot.get_cog('BotSQL')
+            mycursor = await botsql.get_cursor()
+            sql = """SELECT savezdos, savesec, worldsize, timestamp FROM exstats WHERE savesec is not null AND savezdos is not null ORDER BY timestamp DESC LIMIT 1"""
+            mycursor.execute(sql)
+            Info = mycursor.fetchall()
+            row_count = mycursor.rowcount
+            if row_count == 1:
+                Info=Info[0]
+                sembed = discord.Embed(title="World File Save Stats", color=0x407500, timestamp=datetime.utcfromtimestamp(Info[3]))
+                sembed.set_footer(text="Last saved")
+                sembed.add_field(name="Zdos Saved:",
+                               value='{}'.format(Info[0]),
+                               inline=True)
+                sembed.add_field(name="Saving Took:",
+                              value='{}ms'.format(Info[1]),
+                              inline=True)
+                if config.WORLDSIZE == True:
+                    sembed.add_field(name="World Size:",
+                                  value='{}MB'.format(Info[2]),
+                                  inline=True)
+                await ctx.send(embed=sembed)
+            else:
+                await ctx.send(content=':no_entry_sign: No World File Save Stats Found')
+            mycursor.close()
+        else:
+            await ctx.send(content=':no_entry_sign: Extra Server Info is turned off, turn on to see save stats')
+
+def setup(bot):
+    bot.add_cog(Main(bot))