Paginate the help command and snippets

Author: kyb3r

bot.py

@@ -24,23 +24,26 @@
 
 __version__ = '1.3.7'
 
-import discord
-from discord.ext import commands
-import aiohttp
+from contextlib import redirect_stdout
 from urllib.parse import urlparse
+from copy import deepcopy
 import asyncio
 import textwrap
+import traceback
 import datetime
+import inspect
+import string
 import time
 import json
-import sys
 import os
 import re
-import string
-import traceback
 import io
-import inspect
-from contextlib import redirect_stdout
+
+import discord
+from discord.ext import commands
+from paginator import PaginatorSession
+import aiohttp
+
 
 class Github:
     head = 'https://api.github.com/repos/kyb3r/modmail/git/refs/heads/master'
@@ -206,13 +209,12 @@ def overwrites(self, ctx, modrole=None):
     def help_embed(self, prefix):
         em = discord.Embed(color=0x00FFFF)
         em.set_author(name='Mod Mail - Help', icon_url=self.user.avatar_url)
-        em.description = 'This bot is a python implementation of a "Mod Mail" bot. ' \
-                         'Made by kyb3r and improved by the suggestions of others.' 
+        em.description = 'Here is a list of commands for the bot.'
 
         cmds = f'`{prefix}setup` - Sets up the categories that will be used by the bot.\n' \
                f'`{prefix}about` - Shows general information about the bot.\n' \
                f'`{prefix}contact` - Allows a moderator to initiate a thread with a given recipient.\n' \
-               f'`{prefix}reply <message...>` - Sends a message to the current thread\'s recipient.\n' \
+               f'`{prefix}reply` - Sends a message to the current thread\'s recipient.\n' \
                f'`{prefix}close` - Closes the current thread and deletes the channel.\n' \
                f'`{prefix}archive` - Closes the thread and moves the channel to archive category.\n' \
                f'`{prefix}block` - Blocks a user from using modmail.\n' \
@@ -244,7 +246,7 @@ def help_embed(self, prefix):
         em.add_field(name='Custom Mentions', value=mention)
         em.add_field(name='Warning', value=warn)
         em.add_field(name='Github', value='https://github.com/kyb3r/modmail')
-        em.set_footer(text=f'Modmail v{__version__} | Star the repository to unlock hidden features! /s')
+        em.set_footer(text=f'modmail v{__version__} • A star on the repository is appreciated.')
 
         return em
 
@@ -283,8 +285,16 @@ def uptime(self):
     @commands.command()
     async def help(self, ctx):
         prefix = self.config.get('PREFIX', 'm.')
-        em = self.help_embed(prefix)
-        await ctx.send(embed=em)
+
+        em1 = self.help_embed(prefix)
+        em2 = deepcopy(em1)
+        em1.set_footer(text=f'modmail v{__version__}')
+        em2.description = None
+        em2.remove_field(0)
+        em1._fields = em1._fields[0:1]
+
+        session = PaginatorSession(ctx, em1, em2)
+        await session.run()
 
     @commands.command()
     async def about(self, ctx):
@@ -391,16 +401,28 @@ async def setup(self, ctx, *, modrole: discord.Role=None):
     @commands.has_permissions(manage_messages=True)
     async def _snippets(self, ctx):
         '''Returns a list of snippets that are currently set.'''
+        embeds = []
+
         em = discord.Embed(color=discord.Color.green())
         em.set_author(name='Snippets', icon_url=ctx.guild.icon_url)
-        first_line = 'Here is a list of snippets that are currently configured. '
+
+        embeds.append(em)
+
+        em.description = 'Here is a list of snippets that are currently configured.'
+
         if not self.snippets:
-            first_line = 'You dont have any snippets at the moment. '
-        em.description =  first_line + 'You can add snippets by adding config variables in the form' \
-                         ' **`SNIPPET_{NAME}`**'
+            em.color = discord.Color.red()
+            em.description = 'You dont have any snippets at the moment.'
+        
         for name, value in self.snippets.items():
+            if len(em.fields) == 5:
+                em = discord.Embed(color=discord.Color.green(), description=em.description)
+                em.set_author(name='Snippets', icon_url=ctx.guild.icon_url)
+                embeds.append(em)
             em.add_field(name=name, value=value, inline=False)
-        await ctx.send(embed=em)
+        
+        session = PaginatorSession(ctx, *embeds)
+        await session.run()
 
     @commands.command()
     @commands.has_permissions(administrator=True)

paginator.py

@@ -0,0 +1,140 @@
+import discord
+from discord.ext import commands
+from collections import OrderedDict
+import asyncio
+import inspect
+
+class PaginatorSession:
+    '''
+    Class that interactively paginates a set of embeds
+
+    Parameters
+    ------------
+    ctx: Context
+        The context of the command.
+    timeout:
+        How long to wait for before the session closes
+    embeds: List[discord.Embed]
+        A list of entries to paginate.
+
+    Methods
+    -------
+    add_page:
+        Add an embed to paginate
+    run:
+        Run the interactive session
+    close:
+        Forcefully destroy a session
+    '''
+    def __init__(self, ctx, *embeds, **options):
+        self.ctx = ctx
+        self.timeout = options.get('timeout', 60)
+        self.embeds = embeds
+        self.running = False
+        self.base = None
+        self.current = 0
+        self.reaction_map = {
+            '⏮': self.first_page,
+            '◀': self.previous_page,
+            '▶': self.next_page,
+            '⏭': self.last_page,
+            # '⏹': self.close
+            }
+        if options.get('edit_footer', True) and len(self.embeds) > 1:
+            for i, em in enumerate(self.embeds):
+                footer_text = f'Page {i+1} of {len(self.embeds)}'
+                em.footer.text = options.get('footer_text', em.footer.text)
+                if em.footer.text:
+                    footer_text = footer_text + ' • ' + em.footer.text
+                em.set_footer(text=footer_text, icon_url=em.footer.icon_url)
+
+
+    def add_page(self, embed):
+        if isinstance(embed, discord.Embed):
+            self.embeds.append(embed)
+        else:
+            raise TypeError('Page must be an Embed object.')
+
+    async def create_base(self, embed):
+        self.base = await self.ctx.send(embed=embed)
+
+        if len(self.embeds) == 1:
+            self.running = False
+            return 
+
+        self.running = True
+        for reaction in self.reaction_map.keys():
+            if len(self.embeds) == 2 and reaction in '⏮⏭':
+                continue
+            await self.base.add_reaction(reaction)
+
+    async def show_page(self, index: int):
+        if not 0 <= index < len(self.embeds):
+            return
+
+        self.current = index
+        page = self.embeds[index]
+
+        if self.running:
+            await self.base.edit(embed=page)
+        else:
+            await self.create_base(page)
+
+    def react_check(self, reaction, user):
+        if user.id != self.ctx.author.id:
+            return False
+        if reaction.message.id != self.base.id:
+            return False
+        if reaction.emoji in self.reaction_map.keys():
+            return True
+
+    async def run(self):
+        if not self.running:
+            await self.show_page(0)
+        while self.running:
+            try:
+                reaction, user = await self.ctx.bot.wait_for('reaction_add', check=self.react_check, timeout=self.timeout)
+            except asyncio.TimeoutError:
+                self.paginating = False
+                await self.close(delete=False)
+            else:
+                action = self.reaction_map.get(reaction.emoji)
+                await action()
+            try:
+                await self.base.remove_reaction(reaction, user)
+            except:
+                pass
+            
+            
+    def previous_page(self):
+        '''Go to the previous page.'''
+        return self.show_page(self.current-1)
+
+    def next_page(self):
+        '''Go to the next page'''
+        return self.show_page(self.current+1)
+
+    async def close(self, delete=True):
+        '''Delete this embed.'''
+        self.running = False
+
+        try:
+            await self.ctx.message.add_reaction('✅')
+        except:
+            pass
+
+        if delete:
+            return await self.base.delete()
+            
+        try:
+            await self.base.clear_reactions()
+        except:
+            pass
+
+    def first_page(self):
+        '''Go to immediately to the first page'''
+        return self.show_page(0)
+
+    def last_page(self):
+        '''Go to immediately to the last page'''
+        return self.show_page(len(self.embeds)-1)