Merge branch 'staging' into feature-gems

bot/modules/__init__.py

@@ -13,3 +13,4 @@ from .renting import *
 from .moderation import *
 from .accountability import *
 from .plugins import *
+from .sponsors import *

bot/modules/meta/help.py

@@ -10,7 +10,7 @@ from .lib import guide_link
 
 
 new_emoji = " 🆕"
-new_commands = {'achievements', 'nerd', 'invite', 'support'}
+new_commands = {'botconfig', 'sponsors'}
 
 # Set the command groups to appear in the help
 group_hints = {

bot/modules/sponsors/__init__.py

@@ -0,0 +1,5 @@
+from . import module
+
+from . import data
+from . import config
+from . import commands

bot/modules/sponsors/commands.py

@@ -0,0 +1,14 @@
+from .module import module
+
+
+@module.cmd(
+    name="sponsors",
+    group="Meta",
+    desc="Check out our wonderful partners!",
+)
+async def cmd_sponsors(ctx):
+    """
+    Usage``:
+        {prefix}sponsors
+    """
+    await ctx.reply(**ctx.client.settings.sponsor_message.args(ctx))

bot/modules/sponsors/config.py

@@ -0,0 +1,92 @@
+from cmdClient.checks import is_owner
+
+from settings import AppSettings, Setting, KeyValueData, ListData
+from settings.setting_types import Message, String, GuildIDList
+
+from meta import client
+from core.data import app_config
+
+from .data import guild_whitelist
+
+@AppSettings.attach_setting
+class sponsor_prompt(String, KeyValueData, Setting):
+    attr_name = 'sponsor_prompt'
+    _default = None
+
+    write_ward = is_owner
+
+    display_name = 'sponsor_prompt'
+    category = 'Sponsors'
+    desc = "Text to send after core commands to encourage checking `sponsors`."
+    long_desc = (
+        "Text posted after several commands to encourage users to check the `sponsors` command. "
+        "Occurences of `{{prefix}}` will be replaced by the bot prefix."
+    )
+
+    _quote = False
+
+    _table_interface = app_config
+    _id_column = 'appid'
+    _key_column = 'key'
+    _value_column = 'value'
+    _key = 'sponsor_prompt'
+
+    @classmethod
+    def _data_to_value(cls, id, data, **kwargs):
+        if data:
+            return data.replace("{prefix}", client.prefix)
+        else:
+            return None
+
+    @property
+    def success_response(self):
+        if self.value:
+            return "The sponsor prompt has been update."
+        else:
+            return "The sponsor prompt has been cleared."
+
+
+@AppSettings.attach_setting
+class sponsor_message(Message, KeyValueData, Setting):
+    attr_name = 'sponsor_message'
+    _default = '{"content": "Coming Soon!"}'
+
+    write_ward = is_owner
+
+    display_name = 'sponsor_message'
+    category = 'Sponsors'
+    desc = "`sponsors` command response."
+
+    long_desc = (
+        "Message to reply with when a user runs the `sponsors` command."
+    )
+
+    _table_interface = app_config
+    _id_column = 'appid'
+    _key_column = 'key'
+    _value_column = 'value'
+    _key = 'sponsor_message'
+
+    _cmd_str = "{prefix}sponsors --edit"
+
+    @property
+    def success_response(self):
+        return "The `sponsors` command message has been updated."
+
+
+@AppSettings.attach_setting
+class sponsor_guild_whitelist(GuildIDList, ListData, Setting):
+    attr_name = 'sponsor_guild_whitelist'
+    write_ward = is_owner
+
+    category = 'Sponsors'
+    display_name = 'sponsor_hidden_in'
+    desc = "Guilds where the sponsor prompt is not displayed."
+    long_desc = (
+        "A list of guilds where the sponsor prompt hint will be hidden (see the `sponsor_prompt` setting)."
+    )
+
+    _table_interface = guild_whitelist
+    _id_column = 'appid'
+    _data_column = 'guildid'
+    _force_unique = True

bot/modules/sponsors/data.py

@@ -0,0 +1,4 @@
+from data import Table
+
+
+guild_whitelist = Table("sponsor_guild_whitelist")

bot/modules/sponsors/module.py

@@ -0,0 +1,27 @@
+import discord
+
+from LionModule import LionModule
+from LionContext import LionContext
+
+from meta import client
+
+
+module = LionModule("Sponsor")
+
+
+sponsored_commands = {'profile', 'stats', 'weekly', 'monthly'}
+
+
+@LionContext.reply.add_wrapper
+async def sponsor_reply_wrapper(func, ctx: LionContext, *args, **kwargs):
+    if ctx.cmd and ctx.cmd.name in sponsored_commands:
+        if (prompt := ctx.client.settings.sponsor_prompt.value):
+            if not ctx.guild or ctx.guild.id not in ctx.client.settings.sponsor_guild_whitelist.value:
+                sponsor_hint = discord.Embed(
+                    description=prompt,
+                    colour=discord.Colour.dark_theme()
+                )
+                if 'embed' not in kwargs:
+                    kwargs['embed'] = sponsor_hint
+
+    return await func(ctx, *args, **kwargs)

bot/modules/sysadmin/__init__.py

@@ -4,3 +4,4 @@ from . import exec_cmds
 from . import guild_log
 from . import status
 from . import blacklist
+from . import botconfig

bot/modules/sysadmin/botconfig.py

@@ -0,0 +1,96 @@
+import difflib
+import discord
+from cmdClient.checks import is_owner
+
+from settings import UserInputError
+
+from utils.lib import prop_tabulate
+
+from .module import module
+
+
+@module.cmd("botconfig",
+            desc="Update global bot configuration.",
+            flags=('add', 'remove'),
+            group="Bot Admin")
+@is_owner()
+async def cmd_botconfig(ctx, flags):
+    """
+    Usage``
+        {prefix}botconfig
+        {prefix}botconfig info
+        {prefix}botconfig <setting>
+        {prefix}botconfig <setting> <value>
+    Description:
+        Usage directly follows the `config` command for guild configuration.
+    """
+    # Cache and map some info for faster access
+    setting_displaynames = {setting.display_name.lower(): setting for setting in ctx.client.settings.settings.values()}
+    appid = ctx.client.conf['data_appid']
+
+    if not ctx.args or ctx.args.lower() in ('info', 'help'):
+        # Fill the setting cats
+        cats = {}
+        for setting in ctx.client.settings.settings.values():
+            cat = cats.get(setting.category, [])
+            cat.append(setting)
+            cats[setting.category] = cat
+
+        # Format the cats
+        sections = {}
+        for catname, cat in cats.items():
+            catprops = {
+                setting.display_name: setting.get(appid).summary if not ctx.args else setting.desc
+                for setting in cat
+            }
+            # TODO: Add cat description here
+            sections[catname] = prop_tabulate(*zip(*catprops.items()))
+
+        # Build the cat page
+        embed = discord.Embed(
+            colour=discord.Colour.orange(),
+            title="App Configuration"
+        )
+        for name, section in sections.items():
+            embed.add_field(name=name, value=section, inline=False)
+
+        await ctx.reply(embed=embed)
+    else:
+        # Some args were given
+        parts = ctx.args.split(maxsplit=1)
+
+        name = parts[0]
+        setting = setting_displaynames.get(name.lower(), None)
+        if setting is None:
+            matches = difflib.get_close_matches(name, setting_displaynames.keys(), n=2)
+            match = "`{}`".format('` or `'.join(matches)) if matches else None
+            return await ctx.error_reply(
+                "Couldn't find a setting called `{}`!\n"
+                "{}"
+                "Use `{}botconfig info` to see all the available settings.".format(
+                    name,
+                    "Maybe you meant {}?\n".format(match) if match else "",
+                    ctx.best_prefix
+                )
+            )
+
+        if len(parts) == 1 and not ctx.msg.attachments:
+            # config <setting>
+            # View config embed for provided setting
+            await setting.get(appid).widget(ctx, flags=flags)
+        else:
+            # config <setting> <value>
+            # Attempt to set config setting
+            try:
+                parsed = await setting.parse(appid, ctx, parts[1] if len(parts) > 1 else '')
+                parsed.write(add_only=flags['add'], remove_only=flags['remove'])
+            except UserInputError as e:
+                await ctx.reply(embed=discord.Embed(
+                    description="{} {}".format('❌', e.msg),
+                    colour=discord.Colour.red()
+                ))
+            else:
+                await ctx.reply(embed=discord.Embed(
+                    description="{} {}".format('✅', setting.get(appid).success_response),
+                    colour=discord.Colour.green()
+                ))

bot/modules/topgg/data.py

@@ -1,4 +1,4 @@
-from data.interfaces import RowTable
+from data.interfaces import RowTable, Table
 
 topggvotes = RowTable(
     'topgg',
@@ -6,3 +6,4 @@ topggvotes = RowTable(
     'voteid'
 )
 
+guild_whitelist = Table('topgg_guild_whitelist')

bot/modules/topgg/module.py

@@ -2,6 +2,8 @@ from LionModule import LionModule
 from LionContext import LionContext
 from core.lion import Lion
 
+from modules.sponsors.module import sponsored_commands
+
 from .utils import get_last_voted_timestamp, lion_loveemote, lion_yayemote
 from .webhook import init_webhook
 
@@ -39,12 +41,16 @@ boostfree_commands = {'config', 'pomodoro'}
 async def topgg_reply_wrapper(func, ctx: LionContext, *args, suggest_vote=True, **kwargs):
     if not suggest_vote:
         pass
-    elif ctx.cmd and (ctx.cmd.name in boostfree_commands or ctx.cmd.group in boostfree_groups):
+    elif not ctx.cmd:
+        pass
+    elif ctx.cmd.name in boostfree_commands or ctx.cmd.group in boostfree_groups:
+        pass
+    elif ctx.guild and ctx.guild.id in ctx.client.settings.topgg_guild_whitelist.value:
         pass
     elif not get_last_voted_timestamp(ctx.author.id):
         upvote_info_formatted = upvote_info.format(lion_yayemote, ctx.best_prefix, lion_loveemote)
 
-        if 'embed' in kwargs:
+        if 'embed' in kwargs and ctx.cmd.name not in sponsored_commands:
             # Add message as an extra embed field
             kwargs['embed'].add_field(
                 name="\u200b",

bot/modules/topgg/settings.py

@@ -1,10 +1,14 @@
-from settings.user_settings import UserSettings, UserSetting
-from settings.setting_types import Boolean
+from cmdClient.checks import is_owner
+
+from settings import UserSettings, UserSetting, AppSettings
+from settings.base import ListData, Setting
+from settings.setting_types import Boolean, GuildIDList
 
 from modules.reminders.reminder import Reminder
 from modules.reminders.data import reminders
 
 from .utils import create_remainder, remainder_content, topgg_upvote_link
+from .data import guild_whitelist
 
 
 @UserSettings.attach_setting
@@ -48,3 +52,21 @@ class topgg_vote_remainder(Boolean, UserSetting):
             return (
                 "I will no longer send you voting reminders."
             )
+
+
+@AppSettings.attach_setting
+class topgg_guild_whitelist(GuildIDList, ListData, Setting):
+    attr_name = 'topgg_guild_whitelist'
+    write_ward = is_owner
+
+    category = 'Topgg Voting'
+    display_name = 'topgg_hidden_in'
+    desc = "Guilds where the topgg vote prompt is not displayed."
+    long_desc = (
+        "A list of guilds where the topgg vote prompt will be hidden."
+    )
+
+    _table_interface = guild_whitelist
+    _id_column = 'appid'
+    _data_column = 'guildid'
+    _force_unique = True