feat(counters): Add basic week and month stats.

src/modules/counters/cog.py

@@ -5,15 +5,20 @@ from datetime import timedelta
 
 import discord
 from discord.ext import commands as cmds
+from discord import app_commands as appcmds
+
 import twitchio
 from twitchio.ext import commands
 
 
 from data.queries import ORDER
-from meta import LionCog, LionBot, CrocBot
-from utils.lib import utc_now
+from meta import LionCog, LionBot, CrocBot, LionContext
+from modules.profiles.community import Community
+from modules.profiles.profile import UserProfile
+from utils.lib import utc_now, paginate_list, pager
 from . import logger
 from .data import CounterData
+from .graphics.weekly import counter_weekly_card, counter_monthly_card
 
 
 class PERIOD(Enum):
@@ -25,6 +30,11 @@ class PERIOD(Enum):
     YEAR = ('this year', 'y', 'year', 'yearly')
 
 
+class ORIGIN(Enum):
+    DISCORD = 'discord'
+    TWITCH = 'twitch'
+
+
 def counter_cmd_factory(
     counter: str,
     response: str,
@@ -32,10 +42,16 @@ def counter_cmd_factory(
     context: Optional[str] = None
 ):
     context = context or f"cmd: {counter}"
-    async def counter_cmd(cog, ctx: commands.Context, *, args: Optional[str] = None):
-        userid = int(ctx.author.id)
-        channelid = int((await ctx.channel.user()).id)
-        period, start_time = await cog.parse_period(channelid, '', default=default_period)
+    async def counter_cmd(
+        cog,
+        ctx: commands.Context | LionContext,
+        origin: ORIGIN,
+        author: UserProfile,
+        community: Community,
+        args: Optional[str]
+    ):
+        userid = author.profileid
+        period, start_time = await cog.parse_period(community, '', default=default_period)
 
         args = (args or '').strip(" 󠀀 ")
         splits = args.split(maxsplit=1)
@@ -69,13 +85,25 @@ def counter_cmd_factory(
             )
         )
 
-    async def lb_cmd(cog, ctx: commands.Context, *, args: str = ''):
-        user = await ctx.channel.user()
-        await ctx.reply(await cog.formatted_lb(counter, args, int(user.id)))
+    async def lb_cmd(
+        cog,
+        ctx: commands.Context | LionContext,
+        origin: ORIGIN,
+        author: UserProfile,
+        community: Community,
+        args: Optional[str]
+    ):
+        await cog.show_lb(ctx, counter, args, author, community, origin)
 
-    async def undo_cmd(cog, ctx: commands.Context):
-        userid = int(ctx.author.id)
-        channelid = int((await ctx.channel.user()).id)
+    async def undo_cmd(
+        cog,
+        ctx: commands.Context | LionContext,
+        origin: ORIGIN,
+        author: UserProfile,
+        community: Community,
+        args: Optional[str]
+    ):
+        userid = author.profileid
         _counter = await cog.fetch_counter(counter)
         query = cog.data.CounterEntry.fetch_where(
             counterid=_counter.counterid,
@@ -107,12 +135,16 @@ class CounterCog(LionCog):
 
     async def cog_load(self):
         self._load_twitch_methods(self.crocbot)
-        await self.load_counter_commands()
 
         await self.data.init()
+
+        await self.load_counter_commands()
         await self.load_counters()
         self.loaded.set()
 
+        profiles = self.bot.get_cog('ProfileCog')
+        profiles.add_profile_migrator(self.migrate_profiles, name='counters')
+
     async def cog_unload(self):
         self._unload_twitch_methods(self.crocbot)
 
@@ -124,18 +156,48 @@ class CounterCog(LionCog):
                 counter.name,
                 row.response
             )
-            cmds = []
-            main_cmd = commands.command(name=row.name)(counter_cb)
-            cmds.append(main_cmd)
-            if row.lbname:
-                lb_cmd = commands.command(name=row.lbname)(lb_cb)
-                cmds.append(lb_cmd)
-            if row.undoname:
-                undo_cmd = commands.command(name=row.undoname)(undo_cb)
-                cmds.append(undo_cmd)
+            twitch_cmds = []
+            disc_cmds = []
+            twitch_cmds.append(
+                commands.command(
+                    name=row.name
+                )(self.twitch_callback(counter_cb))
+            )
+            disc_cmds.append(
+                cmds.hybrid_command(
+                    name=row.name
+                )(self.discord_callback(counter_cb))
+            )
 
-            for cmd in cmds:
+            if row.lbname:
+                twitch_cmds.append(
+                    commands.command(
+                        name=row.lbname
+                    )(self.twitch_callback(lb_cb))
+                )
+                disc_cmds.append(
+                    cmds.hybrid_command(
+                        name=row.lbname
+                    )(self.discord_callback(lb_cb))
+                )
+            if row.undoname:
+                twitch_cmds.append(
+                    commands.command(
+                        name=row.undoname
+                    )(self.twitch_callback(undo_cb))
+                )
+                disc_cmds.append(
+                    cmds.hybrid_command(
+                        name=row.undoname
+                    )(self.discord_callback(undo_cb))
+                )
+
+            for cmd in twitch_cmds:
                 self.add_twitch_command(self.crocbot, cmd)
+            for cmd in disc_cmds:
+                # cmd.cog = self
+                self.bot.add_command(cmd)
+                print(f"Adding command: {cmd}")
 
         logger.info(f"(Re)Loaded {len(rows)} counter commands!")
 
@@ -152,6 +214,87 @@ class CounterCog(LionCog):
             f"Loaded {len(self.counters)} counters."
         )
 
+    async def migrate_profiles(self, source_profile: UserProfile, target_profile: UserProfile):
+        """
+        Move source profile entries to target profile entries
+        """
+        results = ["(Counters)"]
+
+        rows = await self.data.CounterEntry.table.update_where(userid=source_profile.profileid).set(userid=target_profile.profileid)
+        if rows:
+            results.append(
+                f"Migrated {len(rows)} counter entries from source profile."
+            )
+        else:
+            results.append(
+                "No counter entries to migrate in source profile."
+            )
+
+        return ' '.join(results)
+
+    async def user_profile_migration(self):
+        """
+        Manual single-use migration method from the old userid format to the new profileid format.
+        """
+        async with self.bot.db.connection() as conn:
+            self.bot.db.conn = conn
+            async with conn.transaction():
+                entries = await self.data.CounterEntry.fetch_where()
+                for entry in entries:
+                    if entry.userid > 1000:
+                        # Assume userid is a twitch userid
+                        profile = await UserProfile.fetch_from_twitchid(self.bot, entry.userid)
+                        if not profile:
+                            # Need to create
+                            users = await self.crocbot.fetch_users(ids=[entry.userid])
+                            if not users:
+                                continue
+                            user = users[0]
+                            profile = await UserProfile.create_from_twitch(self.bot, user)
+                        await entry.update(userid=profile.profileid)
+        logger.info("Completed single-shot user profile migration")
+
+    # General API
+    def twitch_callback(self, callback):
+        """
+        Generate a Twitch command callback from the given general callback.
+
+        General callback must be of the form 
+        callback(cog, ctx: GeneralContext, origin: ORIGIN, author: Profile, comm: Community, args: Optional[str])
+
+        Return will be a command callback of the form
+        callback(cog, ctx: Context, *, args: Optional[str] = None)
+        """
+        async def command_callback(cog: CounterCog, ctx: commands.Context, *, args: Optional[str] = None):
+            profiles = cog.bot.get_cog('ProfileCog')
+            # Compute author profile
+            author = await profiles.fetch_profile_twitch(ctx.author)
+            # Compute community profile
+            community = await profiles.fetch_community_twitch(await ctx.channel.user())
+            return await callback(cog, ctx, ORIGIN.TWITCH, author, community, args)
+        return command_callback
+
+    def discord_callback(self, callback):
+        """
+        Generate a Discord command callback from the given general callback.
+
+        General callback must be of the form 
+        callback(cog, ctx: GeneralContext, origin: ORIGIN, author: Profile, comm: Community, args: Optional[str])
+
+        Return will be a command callback of the form
+        callback(cog, ctx: LionContext, *, args: Optional[str] = None)
+        """
+        cog = self
+        async def command_callback(ctx: LionContext, *, args: Optional[str] = None):
+            profiles = cog.bot.get_cog('ProfileCog')
+            # Compute author profile
+            author = await profiles.fetch_profile_discord(ctx.author)
+            # Compute community profile
+            community = await profiles.fetch_community_discord(ctx.guild)
+            return await callback(cog, ctx, ORIGIN.DISCORD, author, community, args)
+
+        return command_callback
+
     # Counters API
 
     async def fetch_counter(self, counter: str) -> CounterData.Counter:
@@ -218,6 +361,14 @@ class CounterCog(LionCog):
         results = await query
         return results[0]['counter_total'] if results else 0
 
+    # Manage commands
+    @commands.command()
+    async def countermigration(self, ctx: commands.Context, *, args: Optional[str]=None):
+        if not (ctx.author.is_mod or ctx.author.is_broadcaster):
+            return
+        await self.user_profile_migration()
+        await ctx.reply("Counter userid->profileid migration done.")
+
     # Counters commands
     @commands.command()
     async def counter(self, ctx: commands.Context, name: str, subcmd: Optional[str], *, args: Optional[str]=None):
@@ -225,6 +376,10 @@ class CounterCog(LionCog):
             return
 
         name = name.lower()
+        profiles = self.bot.get_cog('ProfileCog')
+        author = await profiles.fetch_profile_twitch(ctx.author)
+        userid = author.profileid
+        community = await profiles.fetch_community_twitch(await ctx.channel.user())
 
         if subcmd is None or subcmd == 'show':
             # Show
@@ -241,16 +396,14 @@ class CounterCog(LionCog):
                     return
             await self.add_to_counter(
                 name,
-                int(ctx.author.id),
+                userid,
                 value,
                 context='cmd: counter add'
             )
             total = await self.totals(name)
             await ctx.reply(f"'{name}' counter is now: {total}")
         elif subcmd == 'lb':
-            user = await ctx.channel.user()
-            lbstr = await self.formatted_lb(name, args or '', int(user.id))
-            await ctx.reply(lbstr)
+            await self.show_lb(ctx, name, args or '', author, community, origin=ORIGIN.TWITCH)
         elif subcmd == 'clear':
             await self.reset_counter(name)
             await ctx.reply(f"'{name}' counter reset.")
@@ -292,7 +445,7 @@ class CounterCog(LionCog):
         else:
             await ctx.reply(f"Unrecognised subcommand {subcmd}. Supported subcommands: 'show', 'add', 'lb', 'clear', 'alias'.")
 
-    async def parse_period(self, userid: int, periodstr: str, default=PERIOD.STREAM):
+    async def parse_period(self, community: Community, periodstr: str, default=PERIOD.STREAM):
         if periodstr:
             period = next((period for period in PERIOD if periodstr.lower() in period.value), None)
             if period is None:
@@ -306,9 +459,13 @@ class CounterCog(LionCog):
         if period is PERIOD.ALL:
             start_time = None
         elif period is PERIOD.STREAM:
-            streams = await self.crocbot.fetch_streams(user_ids=[userid])
-            if streams:
-                stream = streams[0]
+            twitches = await community.twitch_channels()
+            stream = None
+            if twitches:
+                twitch = twitches[0]
+                streams = await self.crocbot.fetch_streams(user_ids=[int(twitch.channelid)])
+                stream = streams[0] if streams else None
+            if stream:
                 start_time = stream.started_at
             else:
                 period = PERIOD.ALL
@@ -327,21 +484,104 @@ class CounterCog(LionCog):
 
         return (period, start_time)
 
-    async def formatted_lb(self, counter: str, periodstr: str, channelid: int):
+    @cmds.hybrid_command(
+        name='counterlb',
+        description="Show the leaderboard for the given counter."
+    )
+    async def counterlb_dcmd(self, ctx: LionContext, counter: str, period: Optional[str] = None):
+        profiles = self.bot.get_cog('ProfileCog')
+        author = await profiles.fetch_profile_discord(ctx.author)
+        community = await profiles.fetch_community_discord(ctx.guild)
+        await self.show_lb(ctx, counter, period, author, community, ORIGIN.DISCORD)
 
-        period, start_time = await self.parse_period(channelid, periodstr)
+    @cmds.hybrid_command(
+        name='counterstats',
+        description="Show your stats for the given counter."
+    )
+    async def counterstats_dcmd(self, ctx: LionContext, counter: str, period: Optional[str]=None):
+        profiles = self.bot.get_cog('ProfileCog')
+        author = await profiles.fetch_profile_discord(ctx.author)
+        community = await profiles.fetch_community_discord(ctx.guild)
 
+        if period and period.lower() in ('monthly', 'month'):
+            card = await counter_monthly_card(
+                self.bot,
+                userid=ctx.author.id,
+                profile=author,
+                counter=await self.fetch_counter(counter),
+                guildid=ctx.guild.id,
+                offset=0,
+            )
+            await card.render()
+            await ctx.reply(file=card.as_file('stats.png'))
+        else:
+            card = await counter_weekly_card(
+                self.bot,
+                userid=ctx.author.id,
+                profile=author,
+                counter=await self.fetch_counter(counter),
+                guildid=ctx.guild.id,
+                offset=0,
+            )
+            await card.render()
+            await ctx.reply(file=card.as_file('stats.png'))
+
+    async def show_lb(
+            self,
+            ctx: commands.Context | LionContext,
+            counter: str,
+            periodstr: str,
+            caller: UserProfile,
+            community: Community,
+            origin: ORIGIN = ORIGIN.TWITCH
+        ):
+
+        period, start_time = await self.parse_period(community, periodstr)
         lb = await self.leaderboard(counter, start_time=start_time)
-        if lb:
-            userids = list(lb.keys())
-            users = await self.crocbot.fetch_users(ids=userids)
-            name_map = {user.id: user.display_name for user in users}
+        name_map = {}
+        for userid in lb.keys():
+            profile = await UserProfile.fetch(self.bot, userid)
+            name = await profile.get_name()
+            name_map[userid] = name
+
+        if not lb:
+            await ctx.reply(
+                f"{counter} {period.value[-1]} leaderboard is empty!"
+            )
+        elif origin is ORIGIN.TWITCH:
             parts = []
-            for userid, total in lb.items():
+            items = list(lb.items())
+            prefix = 'top 10 ' if len(items) > 10 else ''
+            items = items[:10]
+            for userid, total in items:
                 name = name_map.get(userid, str(userid))
                 part = f"{name}: {total}"
                 parts.append(part)
             lbstr = '; '.join(parts)
-            return f"{counter} {period.value[-1]} leaderboard --- {lbstr}"
-        else:
-            return f"{counter} {period.value[-1]} leaderboard is empty!"
+            await ctx.reply(f"{counter} {period.value[-1]} {prefix}leaderboard --- {lbstr}")
+        elif origin is ORIGIN.DISCORD:
+            title = f"'{counter}' {period.value[-1]} leaderboard"
+
+            lb_strings = []
+            author_index = None
+            max_name_len = min((30, max(len(name) for name in name_map.values())))
+            for i, (uid, total) in enumerate(lb.items()):
+                if author_index is None and uid == caller.profileid:
+                    author_index = i
+                lb_strings.append(
+                    "{:<{}}\t{:<9}".format(
+                        name_map[uid],
+                        max_name_len,
+                        total,
+                    )
+                )
+
+            page_len = 20
+            pages = paginate_list(lb_strings, block_length=page_len, title=title)
+            start_page = author_index // page_len if author_index is not None else 0
+
+            await pager(
+                ctx,
+                pages,
+                start_at=start_page
+            )

src/modules/counters/graphics/weekly.py

@@ -0,0 +1,222 @@
+import itertools
+from typing import Optional
+from datetime import timedelta, datetime
+import calendar
+
+from meta import LionBot
+from gui.cards import WeeklyStatsCard, MonthlyStatsCard
+from gui.base import CardMode
+from modules.profiles.profile import UserProfile
+from babel import LocalBabel
+from modules.statistics.lib import apply_month_offset
+
+from ..data import CounterData
+
+babel = LocalBabel('counters')
+_ = babel._
+
+
+
+async def counter_monthly_card(
+    bot: LionBot,
+    userid: int,
+    profile: UserProfile,
+    counter: CounterData.Counter,
+    guildid: int,
+    offset: int,
+):
+    cog = bot.get_cog('CounterCog')
+    data: CounterData = cog.data
+
+    if guildid:
+        lion = await bot.core.lions.fetch_member(guildid, userid)
+        user = await lion.fetch_member()
+    else:
+        lion = await bot.core.lions.fetch_user(userid)
+        user = await bot.fetch_user(userid)
+    today = lion.today
+
+    month_start = today.replace(day=1, hour=0, minute=0, second=0, microsecond=0)
+    target = apply_month_offset(month_start, offset)
+    target_end = (target + timedelta(days=40)).replace(day=1, hour=0, minute=0) - timedelta(days=1)
+
+    months = [target]
+    for i in range(0, 3):
+        months.append((months[-1] - timedelta(days=1)).replace(day=1))
+    months.reverse()
+
+    rows = await data.CounterEntry.fetch_where(
+        data.CounterEntry.counterid == counter.counterid,
+        data.CounterEntry.userid == profile.profileid,
+        data.CounterEntry.created_at <= target_end,
+        data.CounterEntry.created_at >= months[0],
+    )
+
+    events = [(row.created_at, row.value) for row in rows]
+
+    month_lengths = [
+        (calendar.monthrange(month.year, month.month)[1]) for month in months
+    ]
+    month_dates = []
+    for month, length in zip(months, month_lengths):
+        for day in range(1, length + 1):
+            month_dates.append(datetime(month.year, month.month, day, tzinfo=month.tzinfo))
+
+    monthly_flat = events_to_dayfreq(events, month_dates)
+    print(monthly_flat)
+    
+    monthly = []
+    i = 0
+    for length in month_lengths:
+        this_month = monthly_flat[i : i+length]
+        i += length
+        monthly.append(this_month)
+
+
+    skin = await bot.get_cog('CustomSkinCog').get_skinargs_for(
+        guildid, userid, MonthlyStatsCard.card_id
+    )
+    skin |= {
+        'title_text': f"{counter.name.upper()}",
+        'this_month_text': f"THIS MONTH: {{amount}} {counter.name.upper()}",
+        'last_month_text': f"LAST MONTH: {{amount}} {counter.name.upper()}"
+    }
+
+    if user:
+        username = (user.display_name, '')
+    else:
+        username = (await profile.get_name(), '')
+
+
+    card = MonthlyStatsCard(
+        user=username,
+        timezone=str(lion.timezone),
+        now=lion.now.timestamp(),
+        month=int(target.timestamp()),
+        monthly=monthly,
+        current_streak=-1,
+        longest_streak=-1,
+        skin=skin | {'mode': CardMode.TEXT}
+    )
+    return card
+
+
+
+
+async def counter_weekly_card(
+    bot: LionBot,
+    userid: int,
+    profile: UserProfile,
+    counter: CounterData.Counter,
+    guildid: int,
+    offset: int,
+):
+    cog = bot.get_cog('CounterCog')
+    data: CounterData = cog.data
+
+    if guildid:
+        lion = await bot.core.lions.fetch_member(guildid, userid)
+        user = await lion.fetch_member()
+    else:
+        lion = await bot.core.lions.fetch_user(userid)
+        user = await bot.fetch_user(userid)
+    today = lion.today
+    week_start = today - timedelta(days=today.weekday()) - timedelta(weeks=offset)
+    days = [week_start + timedelta(i) for i in range(-7, 8 if offset else (today.weekday() + 2))]
+
+    rows = await data.CounterEntry.fetch_where(
+        data.CounterEntry.counterid == counter.counterid,
+        data.CounterEntry.userid == profile.profileid,
+        data.CounterEntry.created_at <= days[-1],
+        data.CounterEntry.created_at >= days[0],
+    )
+
+    events = [(row.created_at, row.value) for row in rows]
+
+    daily = events_to_dayfreq(events, days)
+    sessions = events_to_sessions(next(zip(*events), []))
+
+    skin = await bot.get_cog('CustomSkinCog').get_skinargs_for(
+        guildid, userid, WeeklyStatsCard.card_id
+    )
+    skin |= {
+        'title_text': f"{counter.name.upper()}",
+        'this_week_text': f"THIS WEEK: {{amount}} {counter.name.upper()}",
+        'last_week_text': f"LAST WEEK: {{amount}} {counter.name.upper()}"
+    }
+
+    if user:
+        username = (user.display_name, '')
+    else:
+        username = (await profile.get_name(), '')
+
+
+    card = WeeklyStatsCard(
+        user=username,
+        timezone=str(lion.timezone),
+        now=lion.now.timestamp(),
+        week=week_start.timestamp(),
+        daily=tuple(map(int, daily)),
+        sessions=sessions,
+        skin=skin | {'mode': CardMode.TEXT}
+    )
+    return card
+
+
+
+def events_to_dayfreq(events: list[tuple[datetime, int]], days: list[datetime]) -> list[int]:
+    if not days:
+        return []
+
+    last_day = 0
+    dayts = 0
+
+    daymap = {}
+    for day in sorted(days, reverse=True):
+        dayts = day.timestamp()
+        last_day = last_day or (day + timedelta(days=1)).timestamp()
+        daymap[dayts] = 0
+    
+    first_day = dayts
+
+    for tim, count in events:
+        timts = tim.timestamp()
+        if not first_day < timts < last_day:
+            continue
+
+        for day_start in daymap:
+            if timts > day_start:
+                daymap[day_start] += count
+                break
+
+    return list(reversed(daymap.values()))
+
+
+def events_to_sessions(event_times: list[datetime]) -> list[tuple[int, int]]:
+    """
+    Convert a provided list of event times to a session list.
+    """
+    sessions = []
+
+    session_start = None
+    session_end = None
+
+    SESSION_GAP = 60 * 30
+    SESSION_RADIUS = 60 * 30
+
+    for time in sorted(event_times):
+        if session_start and session_end and (time - session_end).total_seconds() - SESSION_RADIUS > SESSION_GAP:
+            session = (int(session_start.timestamp()), int(session_end.timestamp()))
+            sessions.append(session)
+            session_start = None
+            session_end = None
+        
+        if session_start is None:
+            session_start = time - timedelta(seconds=SESSION_RADIUS)
+        session_end = time + timedelta(seconds=SESSION_RADIUS)
+
+    if session_start and session_end:
+        session = (int(session_start.timestamp()), int(session_end.timestamp()))
+        sessions.append(session)
+
+    return sessions

src/modules/nowdoing/cog.py

@@ -202,7 +202,7 @@ class NowDoingCog(LionCog):
             await self.data.Task.table.delete_where(userid=userid)
             task = await self.data.Task.create(
                 userid=userid,
-                name=ctx.author.display_name,
+                name=await profile.get_name(),
                 task=args,
                 started_at=existing.started_at if (existing and edit) else utc_now(),
             )
@@ -272,7 +272,7 @@ class NowDoingCog(LionCog):
             await self.data.Task.table.delete_where(userid=userid)
             task = await self.data.Task.create(
                 userid=userid,
-                name=ctx.author.display_name,
+                name=await profile.get_name(),
                 task=args,
                 started_at=utc_now(),
             )

src/modules/profiles/profile.py

@@ -31,6 +31,30 @@ class UserProfile:
     def __repr__(self):
         return f"<UserProfile profileid={self.profileid} profile={self.profile_row}>"
 
+    async def get_name(self):
+        # TODO: Store a preferred name in the profile preferences
+        # TODO Should have a multi-fetch system
+        name = None
+        twitches = await self.twitch_accounts()
+        if twitches:
+            users = await self.bot.crocbot.fetch_users(
+                    ids=[int(twitches[0].userid)]
+            )
+            if users:
+                user = users[0]
+                name = user.display_name
+
+        if not name:
+            discords = await self.discord_accounts()
+            if discords:
+                user = await self.bot.fetch_user(discords[0].userid)
+                name = user.display_name
+
+        if not name:
+            name = 'Unknown'
+
+        return name
+
     async def attach_discord(self, user: discord.User | discord.Member):
         """
         Attach a new discord user to this profile.
@@ -62,13 +86,21 @@ class UserProfile:
         """
         Fetch the Discord accounts associated to this profile.
         """
-        return await self.data.DiscordProfileRow.fetch_where(profileid=self.profileid)
+        return await self.data.DiscordProfileRow.fetch_where(
+            profileid=self.profileid
+        ).order_by(
+            'created_at'
+        )
 
     async def twitch_accounts(self) -> list[ProfileData.TwitchProfileRow]:
         """
         Fetch the Twitch accounts associated to this profile.
         """
-        return await self.data.TwitchProfileRow.fetch_where(profileid=self.profileid)
+        return await self.data.TwitchProfileRow.fetch_where(
+                profileid=self.profileid
+        ).order_by(
+            'created_at'
+        )
 
     @classmethod
     async def fetch(cls, bot: LionBot, profile_id: int) -> Self:

src/modules/statistics/graphics/leaderboard.py

@@ -8,9 +8,16 @@ async def get_leaderboard_card(
     bot: LionBot, highlightid: int, guildid: int,
     mode: CardMode,
     entry_data: list[tuple[int, int, int]],  # userid, position, time
+    name_map: dict[int, str] = {},
+    extra_skin_args = {},
 ):
     """
     Render a leaderboard card with given parameters.
+
+    Parameters
+    ----------
+    name_map: dict[int, str]
+        Map of userid -> name, used first before cache or fetch. 
     """
     guild = bot.get_guild(guildid)
     if guild is None:
@@ -20,8 +27,12 @@ async def get_leaderboard_card(
     avatars = {}
     names = {}
     missing = []
+
     for userid, _, _ in entry_data:
-        if guild and (member := guild.get_member(userid)):
+        if (name := name_map.get(userid, None)):
+            avatars[userid] = None
+            names[userid] = name
+        elif guild and (member := guild.get_member(userid)):
             avatars[userid] = member.avatar.key if member.avatar else None
             names[userid] = member.display_name
         elif (user := bot.get_user(userid)):
@@ -65,7 +76,7 @@ async def get_leaderboard_card(
         guildid, None, LeaderboardCard.card_id
     )
     card = LeaderboardCard(
-        skin=skin | {'mode': mode},
+        skin=skin | {'mode': mode} | extra_skin_args,
         server_name=guild.name,
         entries=entries,
         highlight=highlight

src/utils/lib.py

@@ -7,6 +7,7 @@ import iso8601  # type: ignore
 import pytz
 import re
 import json
+import asyncio
 from contextvars import Context
 
 import discord
@@ -918,3 +919,126 @@ def write_records(records: list[dict[str, Any]], stream: StringIO):
         for record in records:
             stream.write(','.join(map(str, record.values())))
             stream.write('\n')
+
+
+async def pager(ctx, pages, locked=True, start_at=0, add_cancel=False, **kwargs):
+    """
+    Shows the user each page from the provided list `pages` one at a time,
+    providing reactions to page back and forth between pages.
+    This is done asynchronously, and returns after displaying the first page.
+
+    Parameters
+    ----------
+    pages: List(Union(str, discord.Embed))
+        A list of either strings or embeds to display as the pages.
+    locked: bool
+        Whether only the `ctx.author` should be able to use the paging reactions.
+    kwargs: ...
+        Remaining keyword arguments are transparently passed to the reply context method.
+
+    Returns: discord.Message
+        This is the output message, returned for easy deletion.
+    """
+    cancel_emoji = cross
+    # Handle broken input
+    if len(pages) == 0:
+        raise ValueError("Pager cannot page with no pages!")
+
+    # Post first page. Method depends on whether the page is an embed or not.
+    if isinstance(pages[start_at], discord.Embed):
+        out_msg = await ctx.reply(embed=pages[start_at], **kwargs)
+    else:
+        out_msg = await ctx.reply(pages[start_at], **kwargs)
+
+    # Run the paging loop if required
+    if len(pages) > 1:
+        task = asyncio.create_task(_pager(ctx, out_msg, pages, locked, start_at, add_cancel, **kwargs))
+        # ctx.tasks.append(task)
+    elif add_cancel:
+        await out_msg.add_reaction(cancel_emoji)
+
+    # Return the output message
+    return out_msg
+
+
+async def _pager(ctx, out_msg, pages, locked, start_at, add_cancel, **kwargs):
+    """
+    Asynchronous initialiser and loop for the `pager` utility above.
+    """
+    # Page number
+    page = start_at
+
+    # Add reactions to the output message
+    next_emoji = "▶"
+    prev_emoji = "◀"
+    cancel_emoji = cross
+
+    try:
+        await out_msg.add_reaction(prev_emoji)
+        if add_cancel:
+            await out_msg.add_reaction(cancel_emoji)
+        await out_msg.add_reaction(next_emoji)
+    except discord.Forbidden:
+        # We don't have permission to add paging emojis
+        # Die as gracefully as we can
+        if ctx.guild:
+            perms = ctx.channel.permissions_for(ctx.guild.me)
+            if not perms.add_reactions:
+                await ctx.error_reply(
+                    "Cannot page results because I do not have the `add_reactions` permission!"
+                )
+            elif not perms.read_message_history:
+                await ctx.error_reply(
+                    "Cannot page results because I do not have the `read_message_history` permission!"
+                )
+            else:
+                await ctx.error_reply(
+                    "Cannot page results due to insufficient permissions!"
+                )
+        else:
+            await ctx.error_reply(
+                "Cannot page results!"
+            )
+        return
+
+    # Check function to determine whether a reaction is valid
+    def check(reaction, user):
+        result = reaction.message.id == out_msg.id
+        result = result and str(reaction.emoji) in [next_emoji, prev_emoji]
+        result = result and not (user.id == ctx.bot.user.id)
+        result = result and not (locked and user != ctx.author)
+        return result
+
+    # Begin loop
+    while True:
+        # Wait for a valid reaction, break if we time out
+        try:
+            reaction, user = await ctx.bot.wait_for('reaction_add', check=check, timeout=300)
+        except asyncio.TimeoutError:
+            break
+
+        # Attempt to remove the user's reaction, silently ignore errors
+        asyncio.ensure_future(out_msg.remove_reaction(reaction.emoji, user))
+
+        # Change the page number
+        page += 1 if reaction.emoji == next_emoji else -1
+        page %= len(pages)
+
+        # Edit the message with the new page
+        active_page = pages[page]
+        if isinstance(active_page, discord.Embed):
+            await out_msg.edit(embed=active_page, **kwargs)
+        else:
+            await out_msg.edit(content=active_page, **kwargs)
+
+    # Clean up by removing the reactions
+    try:
+        await out_msg.clear_reactions()
+    except discord.Forbidden:
+        try:
+            await out_msg.remove_reaction(next_emoji, ctx.client.user)
+            await out_msg.remove_reaction(prev_emoji, ctx.client.user)
+        except discord.NotFound:
+            pass
+    except discord.NotFound:
+        pass