Migrate to DSharpPlus.Commands (#243)

* WIP: Update DSharpPlus to 5.0.0-nightly-02379

* Fix missed breaking changes

* Adjust text command names to avoid duplicate commands when registering

Text command names are in the format "commandtextcmd", like "bantextcmd"; the original name ("ban") is now the first alias

* Resolve remaining TODOs

* Fix (at least partially) group commands

* Error handling: Strip "textcmd" from cmd names, fix check failure handling

* Fix [RequirePermissions] usage

* Combine commands that can be combined, move all commands to Commands namespace

* Upgrade DSharpPlus to 5.0.0-nightly-02422

* Remove mistakenly-added file

* Fix incorrect namespaces

* Remove import of deleted namespace

* Restore friendlier note in command syntax error embed

* Use SlashCommandContext for user context commands as workaround for potential DSharpPlus bug

* Prevent !debug overrides from being registered as a slash command

* Upgrade DSharpPlus and switch back to UserCommandContext

Nightly 02426 resolves the bug that was present in DSharpPlus

* Fix missed merge conflict changes / adjust for DSharpPlus.Commands

* Implement a help command for text cmds & fix global cmd registration

* Help: Properly filter out args of type CommandContext

* Help: Show perms error when user lacks perms for requested cmd

* Fix command registration

* Add missing returns to permission error messages

* Correctly show permission errors even on ArgumentParseException

* Fix permission checks

Show correct command names & permissions in RequireHomeserverPerm failure messages, properly honor OwnerOverride

* Lockdown: Only try to FollowUpAsync when slash cmd is used

* Fix flaws in help handler

Fixes aliases not showing for some commands + help failing to show for commands that are not suffixed with 'textcmd'

* fix inverted error msgs in security actions

* fix command permission checks in DMs

* Move 'overrides' group out of 'debug', make 'overrides dump' text-only

* Properly hide subcommands from help that the user lacks perms for

* fix !help outside server showing extra commands it shouldnt

---------

Co-authored-by: Erisa A <[email protected]>

Author: FloatingMilkshake

Cliptok.csproj

@@ -14,8 +14,7 @@
 	<ItemGroup>
 		<PackageReference Include="Abyssal.HumanDateParser" Version="2.0.0-20191113.1" />
 		<PackageReference Include="DSharpPlus" Version="5.0.0-nightly-02430" />
-		<PackageReference Include="DSharpPlus.CommandsNext" Version="5.0.0-nightly-02430" />
-		<PackageReference Include="DSharpPlus.SlashCommands" Version="5.0.0-nightly-02430" />
+		<PackageReference Include="DSharpPlus.Commands" Version="5.0.0-nightly-02430" />
 		<PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="9.0.0" />
 		<PackageReference Include="Microsoft.Extensions.Caching.Abstractions" Version="9.0.0" />
 		<PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="9.0.0" />

CommandChecks/HomeServerPerms.cs

@@ -25,7 +25,7 @@ public enum ServerPermLevel
 
         public static async Task<ServerPermLevel> GetPermLevelAsync(DiscordMember target)
         {
-            if (target.Guild.Id != Program.cfgjson.ServerID)
+            if (target is null || target.Guild is null || target.Guild.Id != Program.cfgjson.ServerID)
                 return ServerPermLevel.Nothing;
 
             // Torch approved of this.
@@ -66,7 +66,7 @@ public static async Task<ServerPermLevel> GetPermLevelAsync(DiscordMember target
         }
 
         [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
-        public class RequireHomeserverPermAttribute : CheckBaseAttribute
+        public class RequireHomeserverPermAttribute : ContextCheckAttribute
         {
             public ServerPermLevel TargetLvl { get; set; }
             public bool WorkOutside { get; set; }
@@ -79,16 +79,19 @@ public RequireHomeserverPermAttribute(ServerPermLevel targetlvl, bool workOutsid
                 OwnerOverride = ownerOverride;
                 TargetLvl = targetlvl;
             }
+        }
 
-            public override async Task<bool> ExecuteCheckAsync(CommandContext ctx, bool help)
+        public class RequireHomeserverPermCheck : IContextCheck<RequireHomeserverPermAttribute>
+        {
+            public async ValueTask<string?> ExecuteCheckAsync(RequireHomeserverPermAttribute attribute, CommandContext ctx)
             {
                 // If the command is supposed to stay within the server and its being used outside, fail silently
-                if (!WorkOutside && (ctx.Channel.IsPrivate || ctx.Guild.Id != Program.cfgjson.ServerID))
-                    return false;
+                if (!attribute.WorkOutside && (ctx.Channel.IsPrivate || ctx.Guild.Id != Program.cfgjson.ServerID))
+                    return "This command must be used in the home server, but was executed outside of it.";
 
                 // bot owners can bypass perm checks ONLY if the command allows it.
-                if (OwnerOverride && Program.cfgjson.BotOwners.Contains(ctx.User.Id))
-                    return true;
+                if (attribute.OwnerOverride && Program.cfgjson.BotOwners.Contains(ctx.User.Id))
+                    return null;
 
                 DiscordMember member;
                 if (ctx.Channel.IsPrivate || ctx.Guild.Id != Program.cfgjson.ServerID)
@@ -100,7 +103,7 @@ public override async Task<bool> ExecuteCheckAsync(CommandContext ctx, bool help
                     }
                     catch (DSharpPlus.Exceptions.NotFoundException)
                     {
-                        return false;
+                        return "The invoking user must be a member of the home server; they are not.";
                     }
                 }
                 else
@@ -109,58 +112,21 @@ public override async Task<bool> ExecuteCheckAsync(CommandContext ctx, bool help
                 }
 
                 var level = await GetPermLevelAsync(member);
-                if (level >= TargetLvl)
-                    return true;
+                if (level >= attribute.TargetLvl)
+                    return null;
 
-                else if (!help && ctx.Command.QualifiedName != "edit")
-                {
-                    var levelText = level.ToString();
-                    if (level == ServerPermLevel.Nothing && Program.rand.Next(1, 100) == 69)
-                        levelText = $"naught but a thing, my dear human. Congratulations, you win {Program.rand.Next(1, 10)} bonus points.";
-
-                    await ctx.RespondAsync(
-                        $"{Program.cfgjson.Emoji.NoPermissions} Invalid permissions to use command **{ctx.Command.Name}**!\n" +
-                        $"Required: `{TargetLvl}`\nYou have: `{levelText}`");
-                }
-                return false;
+                return "The invoking user does not have permission to use this command.";
             }
         }
 
-        public class HomeServerAttribute : CheckBaseAttribute
-        {
-            public override async Task<bool> ExecuteCheckAsync(CommandContext ctx, bool help)
-            {
-                return !ctx.Channel.IsPrivate && ctx.Guild.Id == Program.cfgjson.ServerID;
-            }
-        }
+        public class HomeServerAttribute : ContextCheckAttribute;
 
-        public class SlashRequireHomeserverPermAttribute : SlashCheckBaseAttribute
+        public class HomeServerCheck : IContextCheck<HomeServerAttribute>
         {
-            public ServerPermLevel TargetLvl;
-            public bool OwnerOverride;
-
-            public SlashRequireHomeserverPermAttribute(ServerPermLevel targetlvl, bool ownerOverride = false)
+            public async ValueTask<string?> ExecuteCheckAsync(HomeServerAttribute attribute, CommandContext ctx)
             {
-                TargetLvl = targetlvl;
-                OwnerOverride = ownerOverride;
-            }
-
-            public override async Task<bool> ExecuteChecksAsync(InteractionContext ctx)
-            {
-                if (ctx.Guild.Id != Program.cfgjson.ServerID)
-                    return false;
-                
-                // bot owners can bypass perm checks ONLY if the command allows it.
-                if (OwnerOverride && Program.cfgjson.BotOwners.Contains(ctx.User.Id))
-                    return true;
-
-                var level = await GetPermLevelAsync(ctx.Member);
-                if (level >= TargetLvl)
-                    return true;
-                else
-                    return false;
+                return !ctx.Channel.IsPrivate && ctx.Guild.Id == Program.cfgjson.ServerID ? null : "This command must be used in the home server, but was executed outside of it.";
             }
         }
-
     }
 }

CommandChecks/OwnerChecks.cs

@@ -1,20 +1,18 @@
 namespace Cliptok.CommandChecks
 {
-    public class IsBotOwnerAttribute : CheckBaseAttribute
+    public class IsBotOwnerAttribute : ContextCheckAttribute;
+
+    public class IsBotOwnerCheck : IContextCheck<IsBotOwnerAttribute>
     {
-        public override async Task<bool> ExecuteCheckAsync(CommandContext ctx, bool help)
+        public async ValueTask<string?> ExecuteCheckAsync(IsBotOwnerAttribute attribute, CommandContext ctx)
         {
             if (Program.cfgjson.BotOwners.Contains(ctx.User.Id))
             {
-                return true;
+                return null;
             }
             else
             {
-                if (!help)
-                {
-                    await ctx.RespondAsync($"{Program.cfgjson.Emoji.NoPermissions} This command is only accessible to bot owners.");
-                }
-                return false;
+                return "Bot owner-only command was executed by a non-owner.";
             }
         }
     }

CommandChecks/UserRoleChecks.cs

@@ -1,10 +1,12 @@
 namespace Cliptok.CommandChecks
 {
-    public class UserRolesPresentAttribute : CheckBaseAttribute
+    public class UserRolesPresentAttribute : ContextCheckAttribute;
+
+    public class UserRolesPresentCheck : IContextCheck<UserRolesPresentAttribute>
     {
-        public override async Task<bool> ExecuteCheckAsync(CommandContext ctx, bool help)
+        public async ValueTask<string?> ExecuteCheckAsync(UserRolesPresentAttribute attribute, CommandContext ctx)
         {
-            return Program.cfgjson.UserRoles is not null;
+            return Program.cfgjson.UserRoles is null ? "A user role command was executed, but user roles are not configured in config.json." : null;
         }
     }
 }