feat: interaction paginator

docs/changelog.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+
+- Interaction Paginator that uses discord buttons (#50)
 - docker-compose.yml (#13)
     - Running the bot after configuring the env vars is now as simple as `docker-compose up`
 - Automatic docker image creation: `ghcr.io/discord-modmail/modmail` (#19)

modmail/extensions/extension_manager.py

@@ -15,6 +15,7 @@
 from modmail.log import ModmailLogger
 from modmail.utils.cogs import BotModes, ExtMetadata, ModmailCog
 from modmail.utils.extensions import EXTENSIONS, NO_UNLOAD, unqualify, walk_extensions
+from modmail.utils.pagination import ButtonPaginator
 
 log: ModmailLogger = logging.getLogger(__name__)
 
@@ -84,6 +85,7 @@ class ExtensionManager(ModmailCog, name="Extension Manager"):
     """
 
     type = "extension"
+    module_name = "extensions"  # modmail/extensions
 
     def __init__(self, bot: ModmailBot):
         self.bot = bot
@@ -179,14 +181,16 @@ async def list_extensions(self, ctx: Context) -> None:
         for category, extensions in sorted(categories.items()):
             # Treat each category as a single line by concatenating everything.
             # This ensures the paginator will not cut off a page in the middle of a category.
+            log.trace(f"Extensions in category {category}: {extensions}")
             category = category.replace("_", " ").title()
             extensions = "\n".join(sorted(extensions))
             lines.append(f"**{category}**\n{extensions}\n")
 
         log.debug(f"{ctx.author} requested a list of all {self.type}s. " "Returning a paginated list.")
 
-        # TODO: since we currently don't have a paginator.
-        await ctx.send("".join(lines) or f"There are no {self.type}s installed.")
+        await ButtonPaginator.paginate(
+            lines or f"There are no {self.type}s installed.", ctx.message, embed=embed
+        )
 
     @extensions_group.command(name="refresh", aliases=("rewalk", "rescan"))
     async def resync_extensions(self, ctx: Context) -> None:
@@ -222,7 +226,10 @@ def group_extension_statuses(self) -> t.Mapping[str, str]:
                 status = ":red_circle:"
 
             root, name = ext.rsplit(".", 1)
-            category = " - ".join(root.split("."))
+            if root.split(".", 1)[1] == self.module_name:
+                category = f"General {self.type}s"
+            else:
+                category = " - ".join(root.split(".")[2:])
             categories[category].append(f"{status}  {name}")
 
         return dict(categories)

modmail/extensions/plugin_manager.py

@@ -25,6 +25,7 @@ class PluginManager(ExtensionManager, name="Plugin Manager"):
     """Plugin management commands."""
 
     type = "plugin"
+    module_name = "plugins"  # modmail/plugins
 
     def __init__(self, bot: ModmailBot) -> None:
         super().__init__(bot)

modmail/extensions/utils/paginator_manager.py

@@ -0,0 +1,58 @@
+from __future__ import annotations
+
+import asyncio
+import logging
+from typing import TYPE_CHECKING
+
+from discord import InteractionType
+
+from modmail.utils.cogs import ModmailCog
+
+if TYPE_CHECKING:
+    from discord import Interaction
+
+    from modmail.bot import ModmailBot
+    from modmail.log import ModmailLogger
+
+logger: ModmailLogger = logging.getLogger(__name__)
+
+
+class PaginatorManager(ModmailCog):
+    """Handles paginators that were still active when the bot shut down."""
+
+    def __init__(self, bot: ModmailBot):
+        self.bot = bot
+
+    @ModmailCog.listener()
+    async def on_interaction(self, interaction: Interaction) -> None:
+        """
+        Remove components from paginator messages if they fail.
+
+        The paginator handles all interactions while it is active, but if the bot is restarted,
+        those interactions stop being dealt with.
+
+        This handles all paginator interactions that fail, which should only happen if
+        the paginator was unable to delete its message.
+        """
+        # paginator only has component interactions
+        if not interaction.type == InteractionType.component:
+            return
+        logger.debug(f"Interaction sent by {interaction.user}.")
+        logger.trace(f"Interaction data: {interaction.data}")
+        if (
+            interaction.data["custom_id"].startswith("pag_")
+            and interaction.message.author.id == self.bot.user.id
+        ):
+            # sleep for two seconds to give the paginator time to respond.
+            # this is due to discord requiring a response within 3 seconds,
+            # and we don't want to let the paginator fail.
+            await asyncio.sleep(2)
+            if not interaction.response.is_done():
+                await interaction.response.send_message(content="This paginator has expired.", ephemeral=True)
+                await asyncio.sleep(0.1)  # sleep for just a moment so we don't jar the user
+                await interaction.message.edit(view=None)
+
+
+def setup(bot: ModmailBot) -> None:
+    """Add the paginator cleaner to the bot."""
+    bot.add_cog(PaginatorManager(bot))

modmail/utils/errors.py

@@ -0,0 +1,10 @@
+class MissingAttributeError(Exception):
+    """Missing attribute."""
+
+    pass
+
+
+class InvalidArgumentError(Exception):
+    """Improper argument."""
+
+    pass