reaction-based AFK check and reminder canceling

Author: 3zachm

TODO.md

@@ -33,9 +33,9 @@ Keeping track of what needs to be done c:
 
 ### 1/31/2021 → x
 
-- [ ] React-confirmation for servers
-  - [ ] Require reaction for next timer to go off
-  - [ ] Stop timer through reaction
+- [x] React-confirmation for servers
+  - [x] Require reaction for next timer to go off
+  - [x] Stop timer through reaction
 - [ ] Command Exceptions
   - [ ] Missing requirements per cmd
 - [x] Optimizations

run.py

@@ -71,6 +71,7 @@ def get_prefix(bot, message):
 bot = commands.Bot(command_prefix = get_prefix)
 bot.remove_command('help')
 bot.coroutineList = []
+use_screen = True
 
 @bot.event
 async def on_ready():
@@ -81,7 +82,10 @@ async def on_ready():
     await bot.change_presence(activity=discord.Activity(type=discord.ActivityType.playing, name="booting..."))
     # start periodic presence update
     asyncio.create_task(update_presence())
-    asyncio.create_task(screen.loop(bot))
+    if use_screen:
+        asyncio.create_task(screen.loop(bot))
+    else:
+        print("Screen disabled\n\nRunning...")
 
 @bot.event
 async def on_guild_join(guild):
@@ -200,7 +204,7 @@ async def reminder_stop(ctx, request):
     else:
         try:
             rq_json = requests.retrieve_json(user.id, files.request_dir(), request)
-            requests.remove(user.id, files.request_dir(), int(request), bot.coroutineList)
+            requests.remove(files.request_dir(), rq_json['request'], bot.coroutineList)
             embed = embeds.reminder_cancel(ctx, rq_json)
         except IndexError:
             embed = embeds.reminder_cancel_index(ctx, guild_prefix(ctx), request)
@@ -209,11 +213,13 @@ async def reminder_stop(ctx, request):
 # add information for embed
 async def timer(ctx, rq_json):
     t = rq_json["time"]
-    user = ctx.message.author
+    react = None
+    pfx = guild_prefix(ctx)
     while(True):
         await asyncio.sleep(t)
-        embed=embeds.timer_end(ctx=ctx, pfx=guild_prefix(ctx), rq_json=rq_json)
-        await ctx.send("<@!" + str(user.id) + ">", embed=embed)
+        if react is not None:
+            react.cancel()
+        react = asyncio.create_task(embeds.timer_end(ctx, pfx, rq_json))
 
 async def update_presence():
     while(True):

utils/embed_generator.py

@@ -3,9 +3,12 @@
 from discord import Embed
 import utils.utils as utils
 import utils.commands as cmds
+import utils.request_manager as requests
+import utils.file_manager as files
 
 empty = Embed.Empty
 all_control_emoji = ["⏮", "⬅️", "➡️", "⏭"]
+confirm_control_emoji = ["✅","❌"]
 
 # add aliases
 async def help(ctx, pfx, bot):
@@ -77,6 +80,17 @@ def reminder_cancel(ctx, rq_json):
     embed.set_footer(text=user.name, icon_url=user.avatar_url)
     return embed
 
+
+def reminder_cancel_timeout(ctx, rq_json):
+    user = ctx.message.author
+    embed=discord.Embed(
+        title="Your reminder for ``" + rq_json["name"] + "`` was cancelled",
+        description="No reaction was received before the next reminder occurence",
+        color=0xcc0000
+    )
+    embed.set_footer(text=user.name, icon_url=user.avatar_url)
+    return embed
+
 def reminder_cancel_index(ctx, pfx, rqID):
     user = ctx.message.author
     embed=discord.Embed(
@@ -144,20 +158,65 @@ async def reminder_list(ctx, rqs):
         page_count += 1
     await embed_pages(ctx, embed_list)
 
-def timer_end(ctx, pfx, rq_json):
+async def timer_end(ctx, pfx, rq_json):
     t = rq_json["time"]
     rq_name = rq_json["name"]
     user = ctx.message.author
     embed=discord.Embed(
         title=str(int(t/60)) + " minutes have passed!",
-        description="Your reminder for ``" + rq_name + "`` is up" +
-        "\nTo cancel further reminders, do ``" + pfx + "reminder|r stop [id]``",
+        description="Your reminder for ``" + rq_name + "`` is up (id " + str(requests.get_index(user.id, files.request_dir(), rq_json) + 1) + ")"
+        "\n" +
+        "``React``  ✅  to confirm you aren't AFK by the next occurence" +
+        "\n``React``  ❌  to stop or do ``" + pfx + "reminder|r stop [id]``",
         color=0xedc707,
         timestamp=ctx.message.created_at
     )
     embed.set_author(name=user.name + "", icon_url=user.avatar_url)
+    await timer_react(ctx, embed)
+
+def timer_continue(ctx, rq_json):
+    t = rq_json["time"]
+    rq_name = rq_json["name"]
+    user = ctx.message.author
+    embed=discord.Embed(
+        title="Your reminder will continue  ✅",
+        description="You'll be reminded for ``" + rq_json["name"] + "`` again",
+        color=0x00CC66
+    )
+    embed.set_footer(text=user.name, icon_url=user.avatar_url)
     return embed
 
+async def timer_react(ctx, embed):
+    bot = ctx.bot
+    reaction = None
+    message = await ctx.send("<@!" + str(ctx.message.author.id) + ">", embed=embed)
+    rq_continue = False
+    rq_json = requests.retrieve_json_id(files.request_dir(), ctx.author.id, ctx.message.id)
+    # 5 second grace to ensure it cancels
+    t = rq_json["time"] - 5
+
+    for emoji in confirm_control_emoji:
+        await message.add_reaction(emoji)
+
+    def check(reaction, user):
+        return reaction.message.id == message.id and user == ctx.author
+
+    try:
+        reaction, user = await bot.wait_for('reaction_add', timeout = t, check = check)
+        if str(reaction) == '✅':
+            rq_continue = True
+        elif str(reaction) == '❌':
+            #await remove_reactions(ctx, message)
+            await ctx.send(embed=reminder_cancel(ctx, rq_json))
+            requests.remove(files.request_dir(), ctx.message.id, bot.coroutineList)
+    except asyncio.TimeoutError:
+        requests.remove(files.request_dir(), ctx.message.id, bot.coroutineList)
+        await ctx.send(embed=reminder_cancel_timeout(ctx, rq_json))
+
+    if rq_continue:
+        await ctx.send(embed=timer_continue(ctx, rq_json))
+    await remove_reactions(ctx, message)
+
 def prefix_current(ctx, pfx):
     embed=discord.Embed(
         title="My prefix is ``" + pfx + "`` for this guild",
@@ -227,6 +286,9 @@ def check(reaction, user):
                 pass
         except asyncio.TimeoutError:
             break
+    await remove_reactions(ctx, message)
+
+async def remove_reactions(ctx, message):
     try:
         if ctx.guild is not None:
             await message.clear_reactions()

utils/request_manager.py

@@ -12,13 +12,11 @@ def create(loc, userid, request, rqname, time, guild_name):
     files.make_json(loc + str(userid) + '_' + str(request) + '.json', data) # ./id_rq.json
     return data
 
-def remove(userid, path, request, arr):
-    # get the request number (chronological)
-    request = retrieve_json(userid, path, request)['request']
-    timer_task = arr[utils.return2DIndex(request, arr)][1]
+def remove(path, request_id, arr):
+    timer_task = arr[utils.return2DIndex(request_id, arr)][1]
     timer_task.cancel()
-    del arr[utils.return2DIndex(request, arr)]
-    files.delete_json(path, request)
+    del arr[utils.return2DIndex(request_id, arr)]
+    files.delete_json(path, request_id)
 
 def retrieve_list(userid, path):
     request_list = []
@@ -29,6 +27,16 @@ def retrieve_list(userid, path):
         request_list.append(request)
     return request_list
 
+def retrieve_json_id(path, userid, request_id):
+    request_json = files.get_json(str(userid) + "_" + str(request_id), path)[0]
+    with open(request_json, 'r') as r:
+        rq_json = json.load(r)
+    return rq_json
+
+def get_index(userid, path, rq_json):
+    arr = retrieve_list(userid, path)
+    return arr.index(rq_json)
+
 def retrieve_json(userid, path, request):
     request_files = files.get_json(userid, path)
     request_json = request_files[request - 1]

utils/screen.py

@@ -2,13 +2,11 @@
 import curses
 import discord
 
-stdscr = curses.initscr()
-
 def print_counts(bot):
-    stdscr.addstr(0, 0, "Guilds: " + str(len(bot.guilds)))
-    stdscr.addstr(1, 0, "Requests: " + str(len(bot.coroutineList)))
+    bot.stdscr.addstr(0, 0, "Guilds: " + str(len(bot.guilds)))
+    bot.stdscr.addstr(1, 0, "Requests: " + str(len(bot.coroutineList)))
 
-    stdscr.refresh()
+    bot.stdscr.refresh()
 
 async def main(bot):
     print_counts(bot)
@@ -17,12 +15,12 @@ async def main(bot):
     await asyncio.sleep(5)
     curses.curs_set(0)
     #curses.cbreak()
-    stdscr.nodelay(True)
-    await check_interrupt(stdscr)
+    bot.stdscr.nodelay(True)
+    await check_interrupt(bot)
 
-async def check_interrupt(stdscr):
+async def check_interrupt(bot):
     try:
-        h = stdscr.getch()
+        h = bot.stdscr.getch()
         if h == 3:
             raise KeyboardInterrupt
         if h == 26:
@@ -31,5 +29,6 @@ async def check_interrupt(stdscr):
         quit()
 
 async def loop(bot):
+    bot.stdscr = curses.initscr()
     while True:
         await main(bot)