Make bot use App Commands

Author: Adikso

.github/workflows/main.yml

@@ -17,6 +17,7 @@ jobs:
         run: |
           pip install -r requirements.txt -t .
           mv bashbot.py __main__.py
+          echo '{"version": "${{ github.sha }}"}' > build.json
           zip -r BashBot.zip .
   
       - name: Create Release

.gitignore

@@ -3,4 +3,5 @@ venv/
 __pycache__/
 
 config.toml
-bashbot.log
+bashbot.log
+state.json

README.md

@@ -70,6 +70,9 @@ docker run -d -v $(pwd)/config.toml:/BashBot/config.toml adikso/bashbot
 Now BashBot should start and show later instructions
 
 ### Commands
+
+**Commands are now available as app commands**, but you can still use the old way:
+
 (Every command have to start with prefix. By default it's "$". You can change it in settings. More information about commands after typing "$.help")
 
 Command | Alias | Usage | Description 

bashbot.py

@@ -1,9 +1,10 @@
 import logging
 
-from discord import LoginFailure
+from discord import LoginFailure, Intents
 
 from bashbot.bot import BashBot
 from bashbot.core.settings import settings
+from bashbot.core.state import state
 from bashbot.core.utils import get_logger
 
 logger = get_logger('Launcher')
@@ -21,6 +22,7 @@ def launch():
     setup_logger()
     settings().load()
     settings().load_macros()
+    state().load()
 
     prefix = settings().get('commands.prefixes', ['$'])[0]
     token = settings().get('discord.token')
@@ -30,7 +32,9 @@ def launch():
         return
 
     try:
-        BashBot(prefix).run(token)
+        intents = Intents.default()
+        intents.message_content = True
+        BashBot(prefix, intents=intents).run(token)
     except LoginFailure as e:
         logger.error(e.args[0])
 

bashbot/bot.py

@@ -1,6 +1,7 @@
-from discord import Message, Reaction, User, Status, Game, DMChannel, Embed
+from discord import Message, Status, Game, DMChannel, Embed, Interaction, InteractionType
 from discord.abc import PrivateChannel
 from discord.ext.commands import Bot, Context
+from discord.ui import View, Button
 from discord.utils import oauth_url
 
 from bashbot.command.about import AboutCommand
@@ -21,38 +22,42 @@
 from bashbot.core.exceptions import SessionDontExistException, ArgumentFormatException, TerminalNotFoundException, \
     MacroNotFoundException
 from bashbot.core.settings import settings
-from bashbot.terminal.control import TerminalControl
+from bashbot.core.state import state
 from bashbot.terminal.sessions import sessions
 from bashbot.terminal.terminal import TerminalState
-from bashbot.core.updater import updater
+from bashbot.core.updater import updater, Updater
 from bashbot.core.utils import get_logger, parse_template, extract_prefix, is_command, remove_prefix
 
 
 class BashBot(Bot):
     logger = get_logger('BashBot')
     cmd_logger = get_logger('Command')
 
-    def __init__(self, command_prefix, **options):
-        super().__init__(command_prefix, **options)
-        self.add_cog(OpenCommand())
-        self.add_cog(CloseCommand())
-        self.add_cog(HereCommand())
-        self.add_cog(FreezeCommand())
-        self.add_cog(RenameCommand())
-        self.add_cog(ControlsCommand())
-        self.add_cog(AboutCommand())
-        self.add_cog(RepeatCommand())
-        self.add_cog(MacroCommand())
-        self.add_cog(SelectCommand())
-        self.add_cog(InteractiveCommand())
-        self.add_cog(SubmitCommand())
-        self.add_cog(ExecCommand())
-        self.add_cog(WhitelistCommand())
+    async def setup_hook(self):
+        await self.add_cog(OpenCommand())
+        await self.add_cog(CloseCommand())
+        await self.add_cog(HereCommand())
+        await self.add_cog(FreezeCommand())
+        await self.add_cog(RenameCommand())
+        await self.add_cog(ControlsCommand())
+        await self.add_cog(AboutCommand())
+        await self.add_cog(RepeatCommand())
+        await self.add_cog(MacroCommand())
+        await self.add_cog(SelectCommand())
+        await self.add_cog(InteractiveCommand())
+        await self.add_cog(SubmitCommand())
+        await self.add_cog(ExecCommand())
+        await self.add_cog(WhitelistCommand())
 
         self.remove_command("help")
-        self.add_cog(HelpCommand())
+        await self.add_cog(HelpCommand())
 
     async def on_ready(self):
+        if state()['last_run_version'] != Updater.get_local_commit():
+            self.logger.info('Synchronizing command tree...')
+            await self.tree.sync()
+            self.logger.info('Command tree synchronized')
+
         self.__check_for_updates()
 
         self.logger.info(f'Logged in as {self.user.name} ({self.user.id})')
@@ -71,11 +76,14 @@ def __check_for_updates(self):
         if settings().get('other.check_for_updates'):
             self.logger.info(f'Checking for updates...')
 
-            update_details = updater().check_for_updates(rate_limit=False)
-            if update_details:
-                self.logger.info(f'New update available. Try running `git pull`. '
-                                 f'Commit "{update_details["message"]}" '
-                                 f'({update_details["sha"]})')
+            releases = updater().check_for_updates()
+            if releases is None:
+                self.logger.info(f'Failed to fetch updates information')
+            elif releases:
+                self.logger.info(
+                    f'New updates available. Try running `git pull`. \n' +
+                    '\n'.join([f'- {x["name"]} ({x["html_url"]})' for x in releases])
+                )
             else:
                 self.logger.info(f'BashBot is up to date')
 
@@ -146,6 +154,24 @@ async def on_message(self, message: Message):
             if should_delete_any or (should_delete_interactive and terminal.interactive):
                 await message.delete()
 
+    async def on_interaction(self, interaction: Interaction):
+        if interaction.type != InteractionType.component:
+            return
+
+        terminal = sessions().by_message(interaction.message)
+
+        label = interaction.data['custom_id']
+        if label.startswith('control_') and not terminal:
+            await interaction.response.send_message(content='This terminal is unavailable', ephemeral=True)
+            view = View.from_message(interaction.message)
+            for component in view.children:
+                if isinstance(component, Button):
+                    component.disabled = True
+
+            await interaction.message.edit(view=view)
+            terminal.state = TerminalState.BROKEN
+            terminal.refresh()
+
     async def on_command(self, ctx: Context):
         if not isinstance(ctx.message.channel, DMChannel):
             guild_name = ctx.message.channel.guild.name
@@ -159,20 +185,6 @@ async def on_command(self, ctx: Context):
 
         self.cmd_logger.info(f"[{guild_name}/#{channel_name}] {author_name} invoked command: {content}")
 
-    async def on_reaction_add(self, reaction: Reaction, user: User):
-        if user.bot:
-            return
-
-        terminal = sessions().by_message(reaction.message)
-        if reaction.emoji not in terminal.controls:
-            return
-
-        control: TerminalControl = terminal.controls[reaction.emoji]
-        terminal.send_input(control.text)
-
-    async def on_reaction_remove(self, reaction: Reaction, user: User):
-        await self.on_reaction_add(reaction, user)
-
     async def on_command_error(self, ctx: Context, error):
         message = None
 

bashbot/command/about.py

@@ -2,28 +2,33 @@
 from discord.ext import commands
 from discord.ext.commands import Context
 
-from bashbot.constants import REPOSITORY_URL, REPOSITORY_AUTHOR, THUMBNAIL_URL, EMBED_COLOR
+from bashbot.constants import REPOSITORY_URL, THUMBNAIL_URL, EMBED_COLOR
 from bashbot.core.settings import settings
 from bashbot.core.updater import updater
 
 
 class AboutCommand(commands.Cog):
-    @commands.command(
-        name='.about',
+    @commands.hybrid_command(
+        name='about',
+        aliases=['.about'],
         description='Shows information about project'
     )
     async def about(self, ctx: Context):
         embed = Embed(title='About BashBot', description='BashBot is a Discord bot that allows terminal access via chat.', color=EMBED_COLOR)
-        embed.add_field(name='Github', value=REPOSITORY_URL, inline=False)
-        embed.add_field(name='Author', value=REPOSITORY_AUTHOR, inline=False)
+        embed.add_field(name='Source code', value=REPOSITORY_URL, inline=False)
+        embed.add_field(name='Author', value='[Adikso](https://github.com/Adikso)', inline=False)
         embed.add_field(name='Current version', value=updater().get_local_commit(), inline=False)
         embed.set_thumbnail(url=THUMBNAIL_URL)
 
         if settings().get('other.check_for_updates'):
-            update_details = updater().check_for_updates()
-            if update_details:
-                embed.add_field(name='New update available', value=f'"{update_details["message"]}"\n{update_details["sha"]}', inline=False)
+            releases = updater().check_for_updates()
+            if releases is None:
+                embed.add_field(name='Failed to fetch updates information', value='Try again later', inline=False)
+            elif releases:
+                embed.add_field(name='Updates available', value='\n'.join([f'- [{x["name"]}]({x["html_url"]})' for x in releases]), inline=False)
             else:
                 embed.add_field(name='No updates available', value='BashBot is up to date', inline=False)
+        else:
+            embed.add_field(name='Updates check disabled', value='You can re-enable it via "other.check_for_updates" in the configuration file', inline=False)
 
         await ctx.send(embed=embed)

bashbot/command/close.py

@@ -1,3 +1,4 @@
+from discord import Embed
 from discord.ext import commands
 
 from bashbot.command import session_exists
@@ -7,9 +8,9 @@
 
 
 class CloseCommand(commands.Cog):
-    @commands.command(
-        name='.close',
-        aliases=['.c'],
+    @commands.hybrid_command(
+        name='close',
+        aliases=['.close', '.c'],
         description='Closes current terminal session'
     )
     @session_exists()
@@ -26,4 +27,6 @@ async def close(self, ctx):
             await message.delete()
 
         sessions().remove(terminal)
-        await ctx.send(f"`Closed terminal #{terminal.name}`")
+
+        embed = Embed(description=f"Closed terminal #{terminal.name}", color=0xff0000)
+        await ctx.send(embed=embed)

bashbot/command/controls.py

@@ -1,14 +1,30 @@
-from discord import Message
+import discord
+from discord import Message, Interaction, Embed
 from discord.ext import commands
+from discord.ext.commands import Context
+from discord.ui import View
 
 from bashbot.command import session_exists
+from bashbot.terminal.control import TerminalControl
 from bashbot.terminal.sessions import sessions
 from bashbot.terminal.terminal import Terminal
 
 
+async def controls_callback(interaction: Interaction):
+    label = interaction.data['custom_id']
+    if label.startswith('control_'):
+        label = label[len('control_'):]
+        terminal = sessions().by_message(interaction.message)
+        control: TerminalControl = terminal.controls[label]
+        terminal.send_input(control.text)
+
+    await interaction.response.defer()
+
+
 class ControlsCommand(commands.Cog):
-    @commands.group(
-        name='.controls',
+    @commands.hybrid_group(
+        name='controls',
+        aliases=['.controls'],
         description='Manages terminal controls',
         usage='add/remove [emoji] [content..]'
     )
@@ -18,18 +34,46 @@ async def controls(self, ctx):
 
     @controls.command()
     @session_exists()
-    async def add(self, ctx, emoji_id, content):
+    async def add(self, ctx: Context, label, content):
         terminal: Terminal = sessions().by_channel(ctx.channel)
         message: Message = sessions().find_message(terminal)
 
-        terminal.add_control(emoji_id, content)
-        await message.add_reaction(emoji_id)
+        view = View.from_message(message)
+        view.timeout = None
+
+        button = discord.ui.Button(style=discord.ButtonStyle.gray, label=label, custom_id=f'control_{label}')
+        button.callback = controls_callback
+        view.add_item(button)
+
+        new_message = await message.edit(view=view)
+        sessions().update_message_reference(terminal, new_message)
+
+        terminal.add_control(label, content)
+
+        if ctx.interaction:
+            embed = Embed(description=f"Control added", color=0x00ff00)
+            await ctx.reply(embed=embed, ephemeral=False, delete_after=0)
 
     @controls.command()
     @session_exists()
-    async def remove(self, ctx, emoji_id):
+    async def remove(self, ctx: Context, label: str = None):
         terminal: Terminal = sessions().by_channel(ctx.channel)
         message: Message = sessions().find_message(terminal)
 
-        terminal.remove_control(emoji_id)
-        await message.remove_reaction(emoji_id, message.author)
+        terminal.remove_control(label)
+        view = View.from_message(message)
+
+        for component in view.children:
+            if component.custom_id == label:
+                view.remove_item(component)
+                break
+        else:
+            await ctx.reply(content="Couldn't find specified control")
+            return
+
+        new_message = await message.edit(view=view)
+        sessions().update_message_reference(terminal, new_message)
+
+        if ctx.interaction:
+            embed = Embed(description=f"Control removed", color=0xff0000)
+            await ctx.reply(embed=embed, ephemeral=False, delete_after=0)

bashbot/command/exec.py

@@ -8,9 +8,9 @@
 
 
 class ExecCommand(commands.Cog):
-    @commands.command(
-        name='.exec',
-        aliases=['.e'],
+    @commands.hybrid_command(
+        name='exec',
+        aliases=['.exec', '.e'],
         description='Execute single command',
         usage='<command...>'
     )
@@ -39,4 +39,4 @@ async def exec(self, ctx, *, command):
                 universal_newlines=True,
             )
 
-        await ctx.send(output)
+        await ctx.send(f'```\n{output}\n```')

bashbot/command/freeze.py

@@ -1,15 +1,17 @@
+from discord import Embed
 from discord.ext import commands
 
 from bashbot.command import session_exists
+from bashbot.constants import EMBED_COLOR
 from bashbot.core.exceptions import SessionDontExistException
 from bashbot.terminal.sessions import sessions
 from bashbot.terminal.terminal import TerminalState
 
 
 class FreezeCommand(commands.Cog):
-    @commands.command(
-        name='.freeze',
-        aliases=['.f'],
+    @commands.hybrid_command(
+        name='freeze',
+        aliases=['.freeze', '.f'],
         description='Freezes current terminal session'
     )
     @session_exists()
@@ -25,4 +27,6 @@ async def freeze(self, ctx):
             terminal.state = TerminalState.FROZEN
 
         terminal.refresh()
-        await ctx.send(f"`Changed terminal #{terminal.name} state to {terminal.state.name}`")
+
+        embed = Embed(description=f"Changed terminal #{terminal.name} state to {terminal.state.name}", color=EMBED_COLOR)
+        await ctx.send(embed=embed)