Squashed commit of the following:

commit b047d0c
Author: skillor <[email protected]>
Date:   Fri Mar 18 18:15:52 2022 +0100

    feat: add example module

commit 73b4030
Author: skillor <[email protected]>
Date:   Fri Mar 18 18:15:35 2022 +0100

    feat: paging for reactions

commit 5d90370
Author: skillor <[email protected]>
Date:   Fri Mar 18 16:17:07 2022 +0100

    feat: add blacklisted command

Author: skillor

helpers/db.py

@@ -179,6 +179,11 @@ def get_level_users(self, guild_id) -> List[LevelUser]:
         stmt = db.select(LevelUser).where(LevelUser.guild_id == guild_id)
         return session.scalars(stmt).all()
 
+    def get_blacklisted_level_users(self, guild_id, blacklisted) -> List[LevelUser]:
+        session = self.Session()
+        stmt = db.select(LevelUser).where(db.and_(LevelUser.guild_id == guild_id, LevelUser.blacklisted == blacklisted))
+        return session.scalars(stmt).all()
+
     def get_level_user_xp_boosts(self, guild_id, user_id, current_time=-1) -> List[XPBoost]:
         session = self.Session()
         stmt = db.select(XPBoost).where(db.and_(XPBoost.guild_id == guild_id, XPBoost.user_id == user_id,

helpers/view_helpers.py

@@ -0,0 +1,67 @@
+from typing import *
+
+import discord.ui
+
+
+class CustomButton(discord.ui.Button):
+    def __init__(self,
+                 callback: Callable[['CustomButton', discord.Interaction], Coroutine] = None,
+                 data=None,
+                 *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.data = data
+        self.custom_callback = callback
+
+    async def callback(self, interaction: discord.Interaction):
+        if self.custom_callback:
+            await self.custom_callback(self, interaction)
+
+
+class ViewPaginator:
+    def __init__(self,
+                 pages: List[discord.ui.View] = None,
+                 hide_empty=False
+                 ):
+        if pages is None:
+            pages = []
+        self.pages = pages
+        self.hide_empty = hide_empty
+        self.current_page = 0
+        self.prev_page_label = '️'
+        self.prev_page_emoji = '⬅'
+        self.prev_page_style = discord.ButtonStyle.secondary
+        self.current_page_label = '{}/{}'
+        self.current_page_style = discord.ButtonStyle.secondary
+        self.next_page_label = ''
+        self.next_page_emoji = '➡'
+        self.next_page_style = discord.ButtonStyle.secondary
+
+    def view(self):
+        view = discord.ui.View()
+        for child in self.pages[self.current_page].children:
+            view.add_item(child)
+
+        if len(self.pages) > 1 or not self.hide_empty:
+            async def cb(button, interaction: discord.Interaction):
+                self.current_page += button.data
+                await interaction.response.edit_message(view=self.view())
+
+            view.add_item(CustomButton(cb,
+                                       data=-1,
+                                       row=4,
+                                       label=self.prev_page_label,
+                                       emoji=self.prev_page_emoji,
+                                       style=self.prev_page_style,
+                                       disabled=self.current_page == 0))
+            view.add_item(CustomButton(row=4,
+                                       label=self.current_page_label.format(self.current_page + 1, len(self.pages)),
+                                       style=self.current_page_style,
+                                       disabled=True))
+            view.add_item(CustomButton(cb,
+                                       data=1,
+                                       row=4,
+                                       label=self.next_page_label,
+                                       emoji=self.next_page_emoji,
+                                       style=self.next_page_style,
+                                       disabled=self.current_page == len(self.pages) - 1))
+        return view

i18n.json

@@ -63,6 +63,9 @@
   "LEVELSYSTEM_BLACKLIST_MEMBER_OPTION": "member to black- or whitelist",
   "LEVELSYSTEM_BLACKLIST_BLACKLIST_OPTION": "if user should be blacklisted",
   "LEVELSYSTEM_BLACKLIST_SUCCESSFUL": "User was blacklisted",
+  "LEVELSYSTEM_BLACKLISTED_COMMAND": "blacklisted",
+  "LEVELSYSTEM_BLACKLISTED_COMMAND_DESCRIPTION": "get blacklisted users",
+  "LEVELSYSTEM_BLACKLISTED_TITLE": "Blacklisted",
   "LEVELSYSTEM_BLACKLIST_REMOVE_SUCCESSFUL": "User was removed from the blacklist",
   "LEVELSYSTEM_REMOVE_COMMAND": "remove",
   "LEVELSYSTEM_REMOVE_COMMAND_DESCRIPTION": "remove levelsystem by level",
@@ -136,7 +139,7 @@
   "EMOJI_REACTIONS_TITLE": "Emoji Reactions",
   "EMOJI_REACTIONS_CHOOSE_EMOJI_TITLE": "Choose emoji for reaction action",
   "EMOJI_REACTIONS_CHOOSE_EMOJI_PLACEHOLDER": "Choose the emoji...",
-  "EMOJI_REACTIONS_CUSTOM_EMOJI": "©",
+  "EMOJI_REACTIONS_CUSTOM_EMOJI": "🎇",
   "EMOJI_REACTIONS_CUSTOM_EMOJI_LABEL": "Custom emoji",
   "EMOJI_REACTIONS_CUSTOM_EMOJI_MESSAGE": "React to this message with your wanted emoji!",
   "EMOJI_REACTIONS_ACTION_TYPE_PLACEHOLDER": "Choose your wanted action type...",

modules/_example/__init__.py

@@ -0,0 +1,16 @@
+from helpers.spark_module import SparkModule
+from .settings import SETTINGS
+from .web import API_PAGES
+
+
+class ExampleModule(SparkModule):
+    name = 'example'
+    title = 'Example Module'
+    description = 'A module used as an example'
+    api_pages = API_PAGES
+    settings = SETTINGS
+
+    def __init__(self, bot):
+        super().__init__(bot)
+
+        self.commands = []

modules/_example/settings.py

@@ -0,0 +1,9 @@
+from helpers.settings_manager import Setting
+
+SETTINGS = {
+    'EXAMPLE_SETTING': Setting(
+        value=False,
+        description='An example setting',
+        itype='bool'
+    ),
+}

modules/_example/web.py

@@ -0,0 +1,20 @@
+import discord
+from flask import jsonify
+
+from webserver import Page
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from . import ExampleModule
+
+
+async def example_func(module: 'ExampleModule',
+                       guild: discord.Guild,
+                       member: discord.Member):
+    return jsonify({'msg': 'success'}), 200
+
+
+API_PAGES = [
+    Page(path='example', view_func=example_func, methods=['POST']),
+]

modules/emoji_reactions/__init__.py

@@ -1,4 +1,5 @@
 import json
+import math
 from typing import *
 
 import discord
@@ -8,6 +9,7 @@
 
 from helpers import tools
 from helpers.spark_module import SparkModule
+from helpers.view_helpers import ViewPaginator, CustomButton
 from .settings import SETTINGS
 
 
@@ -65,16 +67,7 @@ def __init__(self, bot):
         @bot.has_permissions(administrator=True)
         async def add_emoji_action(ctx: discord.commands.context.ApplicationContext,
                                    message: discord.Message):
-            async def response(dropdown1: CustomDropdown, interaction1: discord.Interaction):
-                if dropdown1.values[0] != self.CUSTOM_EMOJI:
-                    emoji = get(ctx.guild.emojis, id=int(dropdown1.values[0]))
-                    if not emoji:
-                        return await ctx.edit(embed=discord.Embed(
-                            description=self.bot.i18n.get('UNKNOWN_ERROR'),
-                            color=discord.Color.red()))
-                    await self.add_emoji_reaction_action(ctx.guild, ctx, message, emoji)
-                    return
-
+            async def custom_emoji_response(button: CustomButton, interaction1: discord.Interaction):
                 m = await ctx.send(embed=discord.Embed(
                     description=self.bot.i18n.get('EMOJI_REACTIONS_CUSTOM_EMOJI_MESSAGE'),
                     color=discord.Color.blue()))
@@ -84,33 +77,36 @@ async def response(dropdown1: CustomDropdown, interaction1: discord.Interaction)
 
                 self.activating_reactions[(m.channel.id, m.id)] = (ctx.author.id, ctx, message)
 
-            if len(ctx.guild.emojis) < 24:
-                options = [discord.SelectOption(label=bot.i18n.get('EMOJI_REACTIONS_CUSTOM_EMOJI_LABEL'),
-                                                emoji=bot.i18n.get('EMOJI_REACTIONS_CUSTOM_EMOJI'),
-                                                value=self.CUSTOM_EMOJI)] + [
-                              discord.SelectOption(label=str(emoji.name),
-                                                   emoji=str(emoji),
-                                                   value=str(emoji.id)) for emoji in ctx.guild.emojis
-                          ]
-
+            async def response(dropdown1: CustomDropdown, interaction1: discord.Interaction):
+                emoji = get(ctx.guild.emojis, id=int(dropdown1.values[0]))
+                if not emoji:
+                    return await ctx.edit(embed=discord.Embed(
+                        description=self.bot.i18n.get('UNKNOWN_ERROR'),
+                        color=discord.Color.red()))
+                await self.add_emoji_reaction_action(ctx.guild, ctx, message, emoji)
+
+            options = [
+                          discord.SelectOption(label=str(emoji.name),
+                                               emoji=str(emoji),
+                                               value=str(emoji.id)) for emoji in ctx.guild.emojis
+                      ]
+
+            pages = []
+            for i in range(math.ceil(len(options) / 25)):
                 view = discord.ui.View()
                 view.add_item(
-                    CustomDropdown(response, bot.i18n.get('EMOJI_REACTIONS_CHOOSE_EMOJI_PLACEHOLDER'), options))
-
-                return await ctx.respond(
-                    embed=discord.Embed(title=self.bot.i18n.get('EMOJI_REACTIONS_CHOOSE_EMOJI_TITLE')),
-                    view=view,
-                    ephemeral=True)
-
-            else:
-                m = await ctx.send(embed=discord.Embed(
-                    description=self.bot.i18n.get('EMOJI_REACTIONS_CUSTOM_EMOJI_MESSAGE'),
-                    color=discord.Color.blue()))
+                    CustomButton(custom_emoji_response,
+                                 label=bot.i18n.get('EMOJI_REACTIONS_CUSTOM_EMOJI_LABEL'),
+                                 emoji=bot.i18n.get('EMOJI_REACTIONS_CUSTOM_EMOJI')))
+                view.add_item(
+                    CustomDropdown(response,
+                                   bot.i18n.get('EMOJI_REACTIONS_CHOOSE_EMOJI_PLACEHOLDER'),
+                                   options[i*25:(i+1)*25]))
+                pages.append(view)
 
-                await ctx.respond(embed=discord.Embed(title=self.bot.i18n.get('EMOJI_REACTIONS_REACT_TO'),
-                                                      description=m.jump_url), ephemeral=True)
+            paginator = ViewPaginator(pages, hide_empty=True)
 
-                self.activating_reactions[(m.channel.id, m.id)] = (ctx.author.id, ctx, message)
+            await ctx.respond(view=paginator.view(), ephemeral=True)
 
         @bot.has_permissions(administrator=True)
         async def get_emoji_reactions(ctx: discord.commands.context.ApplicationContext):
@@ -271,13 +267,21 @@ async def response2(dropdown2: CustomDropdown, interaction2: discord.Interaction
                         role_name = role.name
                     options.append(discord.SelectOption(label=role_name, emoji=role_emoji, value=str(role.id)))
 
-                view = discord.ui.View()
-                view.add_item(CustomDropdown(response2,
-                                             self.bot.i18n.get('EMOJI_REACTIONS_CHOOSE_ROLE_PLACEHOLDER'),
-                                             options))
+                pages = []
+                for i in range(math.ceil(len(options) / 25)):
+                    view = discord.ui.View()
+
+                    view.add_item(
+                        CustomDropdown(response2,
+                                       self.bot.i18n.get('EMOJI_REACTIONS_CHOOSE_ROLE_PLACEHOLDER'),
+                                       options[i * 25:(i + 1) * 25]))
+                    pages.append(view)
+
+                paginator = ViewPaginator(pages, hide_empty=True)
+
                 await ctx.edit(embed=discord.Embed(title=self.bot.i18n.get('EMOJI_REACTIONS_CHOOSE_ROLE_TITLE')
                                                    .format(str(emoji), self.bot.i18n.get(self.reaction_types[v]))),
-                               view=view)
+                               view=paginator.view())
 
             else:
                 await ctx.edit(
@@ -349,6 +353,6 @@ async def on_raw_reaction_remove(self, payload: discord.RawReactionActionEvent):
         for action in actions:
             try:
                 if action.action_type == self.TRIGGER_ROLE:
-                    await tools.remove_role(payload.member.guild, payload.member, int(action.action))
-            except:
-                pass
+                    await tools.remove_role(member.guild, member, int(action.action))
+            except Exception as e:
+                self.bot.logger.warning('{} for user {} in {}'.format(e, member, member.guild))

modules/levelsystem/__init__.py

@@ -143,6 +143,18 @@ async def blacklist_user(ctx: discord.commands.context.ApplicationContext,
                                         description=self.bot.i18n.get('LEVELSYSTEM_BLACKLIST_REMOVE_SUCCESSFUL'),
                                         color=discord.Color.green()))
 
+        @bot.has_permissions(administrator=True)
+        async def blacklisted_users(ctx: discord.commands.context.ApplicationContext):
+            description = []
+            for user in self.bot.db.get_blacklisted_level_users(ctx.guild.id, True):
+                member = get(ctx.guild.members, id=int(user.user_id))
+                if member is not None:
+                    description.append(str(member))
+            return await ctx.respond(embed=discord.Embed(
+                title=self.bot.i18n.get('LEVELSYSTEM_BLACKLISTED_TITLE'),
+                description='\n'.join(description),
+                color=discord.Color.green()))
+
         async def profile(ctx: discord.commands.context.ApplicationContext,
                           member: discord.commands.Option(
                               discord.Member,
@@ -204,6 +216,12 @@ async def leaderboard(ctx: discord.commands.context.ApplicationContext):
             description=self.bot.i18n.get('LEVELSYSTEM_BLACKLIST_COMMAND_DESCRIPTION'),
             parent=levelsystem
         ))
+        levelsystem.subcommands.append(discord.SlashCommand(
+            func=blacklisted_users,
+            name=self.bot.i18n.get('LEVELSYSTEM_BLACKLISTED_COMMAND'),
+            description=self.bot.i18n.get('LEVELSYSTEM_BLACKLISTED_COMMAND_DESCRIPTION'),
+            parent=levelsystem
+        ))
         self.commands = [
             levelsystem,
             discord.SlashCommand(