Work around Discord's privileged intents restrictions (#1294)

Koi-3088 · web-flow · commit afac39c2e4f0 · 2026-06-20T15:37:25.000-05:00
* Work around the upcoming restrictions to Discord's privileged intents, implement a button to register slash commands, fix and improve readability of certain commands.

* Implement requested fixes.
diff --git a/SerialPrograms/Source/Integrations/DiscordIntegrationSettings.cpp b/SerialPrograms/Source/Integrations/DiscordIntegrationSettings.cpp
@@ -32,6 +32,10 @@ DiscordIntegrationSettingsOption::DiscordIntegrationSettingsOption()
         LockMode::LOCK_WHILE_RUNNING,
         false
     )
+    , register_slash_button(
+        "<b>Register Slash Commands on Start:</b><br>Only needs to be run once, or after additional commands are added.",
+        "Register Slash Commands"
+    )
     , command_type(
         "<b>Discord Integration Command Type:</b><br>Restart the program for this to take effect.",
         {
@@ -72,6 +76,7 @@ DiscordIntegrationSettingsOption::DiscordIntegrationSettingsOption()
     )
 {
     PA_ADD_OPTION(run_on_start);
+    PA_ADD_OPTION(register_slash_button);
     PA_ADD_OPTION(command_type);
     PA_ADD_OPTION(token);
     PA_ADD_OPTION(command_prefix);
diff --git a/SerialPrograms/Source/Integrations/DiscordIntegrationSettings.h b/SerialPrograms/Source/Integrations/DiscordIntegrationSettings.h
@@ -12,6 +12,7 @@
 #include "Common/Cpp/Options/BooleanCheckBoxOption.h"
 #include "Common/Cpp/Options/StringOption.h"
 #include "Common/Cpp/Options/EnumDropdownOption.h"
+#include "Common/Cpp/Options/ButtonOption.h"
 #include "Common/Qt/Options/GroupWidget.h"
 #include "DiscordIntegrationTable.h"
 
@@ -30,6 +31,7 @@ class DiscordIntegrationSettingsOption
     virtual void on_config_value_changed(void* object) override;
 
     BooleanCheckBoxOption run_on_start;
+    ButtonOption register_slash_button;
 
     enum class CommandType{
         SlashCommands,
diff --git a/SerialPrograms/Source/Integrations/DppIntegration/DppClient.cpp b/SerialPrograms/Source/Integrations/DppIntegration/DppClient.cpp
@@ -29,6 +29,7 @@ Client& Client::instance(){
 
 
 Client::~Client(){
+    GlobalSettings::instance().DISCORD->integration.register_slash_button.remove_listener(*this);
     disconnect();
 }
 
@@ -48,7 +49,12 @@ void Client::connect(){
             return;
 
         std::string token = settings.integration.token;
-        uint32_t intents = intents::i_default_intents | intents::i_guild_members | intents::i_message_content;
+        auto cmd_type = GlobalSettings::instance().DISCORD->integration.command_type.get();
+        uint32_t intents = intents::i_default_intents;
+        if (cmd_type == DiscordIntegrationSettingsOption::CommandType::MessageCommands){
+            intents = intents::i_default_intents | intents::i_message_content;
+        }
+
         try{
             m_bot = std::make_unique<cluster>(token, intents);
             m_handler = std::make_unique<commandhandler>(m_bot.get(), false);
@@ -154,14 +160,8 @@ void Client::run(const std::string& token){
         Handler::initialize(*m_bot.get(), *m_handler.get());
         m_bot->set_websocket_protocol(websocket_protocol_t::ws_etf);
         m_bot->start(st_return);
-        m_bot->set_presence(
-            presence(
-                presence_status::ps_online,
-                activity_type::at_game,
-                (std::string)GlobalSettings::instance().DISCORD->integration.game_status
-            )
-        );
         m_is_connected.store(true, std::memory_order_release);
+        GlobalSettings::instance().DISCORD->integration.register_slash_button.add_listener(*this);
     }catch (std::exception& e){
         Handler::log_dpp("DPP thew an exception: " + (std::string)e.what(), "run()", ll_critical);
         m_handler.reset();
diff --git a/SerialPrograms/Source/Integrations/DppIntegration/DppClient.h b/SerialPrograms/Source/Integrations/DppIntegration/DppClient.h
@@ -7,6 +7,7 @@
 #include <Integrations/DppIntegration/DppCommandHandler.h>
 #include "Common/Cpp/Concurrency/AsyncTask.h"
 #include "CommonFramework/Notifications/MessageAttachment.h"
+#include "Common/Cpp/Options/ButtonOption.h"
 
 namespace PokemonAutomation{
     class JsonObject;
@@ -15,7 +16,7 @@ namespace DppClient{
 
 
 
-class Client : protected DppCommandHandler::Handler{
+class Client : protected DppCommandHandler::Handler, public ButtonListener{
 public:
     Client() : m_is_connected(false) {}
     ~Client();
@@ -42,12 +43,26 @@ class Client : protected DppCommandHandler::Handler{
 
 private:
     void run(const std::string& token);
+    virtual void on_press() override{
+        std::lock_guard<std::mutex> lg(m_register_lock);
+        if (m_handler && m_handler->slash_commands_enabled){
+            GlobalSettings::instance().DISCORD->integration.register_slash_button.set_enabled(false);
+            log_dpp("Registering commands...", "Slash Command Registration", dpp::ll_info);
+            m_handler->register_commands();
+            log_dpp("Registered commands with Discord. You may have to wait or restart Discord for changes to take effect.", "Slash Command Registration", dpp::ll_info);
+            GlobalSettings::instance().DISCORD->integration.register_slash_button.set_enabled(true);
+            return;
+        }
+
+        log_dpp("Failed to register commands. Make sure the bot is connected and Slash commands are enabled.", "Slash Command Registration", dpp::ll_error);
+    };
 
 private:
     std::unique_ptr<dpp::cluster> m_bot = nullptr;
     std::unique_ptr<dpp::commandhandler> m_handler = nullptr;
     std::atomic<bool> m_is_connected;
     std::mutex m_client_lock;
+    std::mutex m_register_lock;
     AsyncTask m_start_thread;
 };
 
diff --git a/SerialPrograms/Source/Integrations/DppIntegration/DppCommandHandler.cpp b/SerialPrograms/Source/Integrations/DppIntegration/DppCommandHandler.cpp
@@ -1,9 +1,9 @@
 #ifdef PA_DPP
 
 #include <format>
+#include <unordered_set>
 #include "Common/Cpp/Concurrency/ScheduledTaskRunner.h"
 #include "CommonFramework/Globals.h"
-#include "CommonFramework/GlobalSettingsPanel.h"
 #include "CommonFramework/Notifications/MessageAttachment.h"
 #include "Integrations/IntegrationsAPI.h"
 #include "Integrations/DiscordSettingsOption.h"
@@ -37,7 +37,7 @@ void Handler::initialize(cluster& bot, commandhandler& handler){
     if (cmd_type == DiscordIntegrationSettingsOption::CommandType::MessageCommands && !prefix.empty()){
         handler.add_prefix(prefix);
     }else{
-        handler.add_prefix("/").add_prefix("_cmd ");
+        handler.add_prefix("/");
     }
 
     bot.on_ready([&bot, &handler, this](const ready_t&){
@@ -53,6 +53,13 @@ void Handler::initialize(cluster& bot, commandhandler& handler){
             log_dpp("Application Name: " + app.name, "Current App", ll_info);
             log_dpp("Application ID: " + std::to_string(app.id), "Current App", ll_info);
             owner = app.owner;
+            bot.set_presence(
+                presence(
+                    presence_status::ps_online,
+                    activity_type::at_game,
+                    (std::string)GlobalSettings::instance().DISCORD->integration.game_status
+                )
+            );
         });
 #else
         log_dpp("Logged in as: " + bot.current_user_get_sync().format_username() + ".", "Ready", ll_info);
@@ -76,48 +83,18 @@ void Handler::initialize(cluster& bot, commandhandler& handler){
         }
     });
 
-    bot.on_guild_member_add([this](const guild_member_add_t& event){
-#if DPP_VERSION_LONG >= 0x00100100 // (dpp version 10.1.0)
-        std::string id = std::to_string(event.adding_guild.id);
-        if (!user_counts.empty() && user_counts.count(id)){
-            log_dpp("New member joined " + event.adding_guild.name + ". Incrementing member count.", "Guild Member Add", ll_info);
-            user_counts.at(id)++;
-        }
-#else
-        std::string id = std::to_string(event.adding_guild->id);
-        if (!user_counts.empty() && user_counts.count(id)){
-            log_dpp("New member joined " + event.adding_guild->name + ". Incrementing member count.", "Guild Member Add", ll_info);
-            user_counts.at(id)++;
-        }
-#endif
-    });
-
-    bot.on_guild_member_remove([this](const guild_member_remove_t& event){
-#if DPP_VERSION_LONG >= 0x00100100 // (dpp version 10.1.0)
-        std::string id = std::to_string(event.removing_guild.id);
-        if (!user_counts.empty() && user_counts.count(id)){
-            log_dpp("Member left " + event.removing_guild.name + ". Decrementing member count.", "Guild Member Remove", ll_info);
-            user_counts.at(id)--;
-        }
-#else
-        std::string id = std::to_string(event.removing_guild->id);
-        if (!user_counts.empty() && user_counts.count(id)){
-            log_dpp("Member left " + event.removing_guild->name + ". Decrementing member count.", "Guild Member Remove", ll_info);
-            user_counts.at(id)--;
-        }
-#endif
-    });
-
-    bot.on_message_create([&handler](const message_create_t& event){
-        std::string content = event.msg.content;
-        if (!event.msg.author.is_bot() && handler.string_has_prefix(content)){
-            auto channels = GlobalSettings::instance().DISCORD->integration.channels.command_channels();
-            auto channel = std::find(channels.begin(), channels.end(), std::to_string(event.msg.channel_id));
-            if (channel != channels.end()){
-                handler.route(event);
+    if (cmd_type == DiscordIntegrationSettingsOption::CommandType::MessageCommands){
+        bot.on_message_create([&handler](const message_create_t& event){
+            std::string content = event.msg.content;
+            if (!event.msg.author.is_bot() && handler.string_has_prefix(content)){
+                auto channels = GlobalSettings::instance().DISCORD->integration.channels.command_channels();
+                auto channel = std::find(channels.begin(), channels.end(), std::to_string(event.msg.channel_id));
+                if (channel != channels.end()){
+                    handler.route(event);
+                }
             }
-        }
-    });
+        });
+    }
 
     bot.on_slashcommand([&handler](const slashcommand_t& event){
         if (!event.command.usr.is_bot() && handler.slash_commands_enabled){
@@ -611,65 +588,65 @@ void Handler::create_unified_commands(commandhandler& handler){
             embed embed;
             embed.set_color((uint32_t)color).set_title("Command List");
 
+            static const std::unordered_set<std::string> base_commands{
+                "hi", "ping", "about", "status", "help"
+            };
+            static const std::unordered_set<std::string> button_commands{
+                "click", "joystick"
+            };
+
+            std::unordered_set<std::string> allowed = base_commands;
+            if (GlobalSettings::instance().DISCORD->integration.allow_buttons_from_users){
+                allowed.insert(button_commands.begin(), button_commands.end());
+            }
+
             auto& commands = handler.commands;
             for (auto& cmd : commands){
-                std::string name = cmd.first;
-                log_dpp(name, "help command", ll_info);
-                if (!GlobalSettings::instance().DISCORD->integration.allow_buttons_from_users &&
-                    src.issuer.id != owner.id && name != "hi" && name != "ping" && name != "about" && name != "status" && name != "help"
-                ){
+                const std::string& cmd_name = cmd.first;
+                if (src.issuer.id != owner.id && allowed.find(cmd_name) == allowed.end()){
                     continue;
                 }
 
-                std::string param_info;
-                for (auto& param : cmd.second.parameters){
-                    param_info += ("\n**- " + param.first + "** - " + param.second.description);
+                auto& params = cmd.second.parameters;
+                std::string signature;
+                if (!params.empty()){
+                    signature = cmd_name + "(";
+                    for (size_t i = 0; i < params.size(); ++i){
+                        signature += params[i].first;
+                        if (i + 1 < params.size()){
+                            signature += ", ";
+                        }
+                    }
+                    signature += ")";
+                }else{
+                    signature = cmd_name;
+                }
+
+                std::string param_details;
+                for (auto& param : params){
+                    param_details += ("\n-" + param.first + ": " + param.second.description);
                     if (!param.second.choices.empty()){
-                        param_info += " (";
-                        for (auto& choice : param.second.choices){
-                            param_info += (choice.second + ", ");
+                        std::string choices;
+                        for (auto& c : param.second.choices){
+                            choices += c.second + ", ";
+                        }
+                        if (!choices.empty()){
+                            choices = choices.substr(0, choices.size() - 2);
                         }
-                        param_info = param_info.substr(0, param_info.size() - 2);
-                        param_info += ")";
+                        param_details += " (" + choices + ")";
                     }
                 }
-                embed.add_field(name, param_info);
+                embed.add_field(signature, param_details);
             }
             embed_footer footer;
             footer.set_text("Commands are case-sensitive!");
             embed.set_footer(footer);
             message.add_embed(embed);
             handler.reply(message, src);
         },
-        "View the command list.")
-            
-    .add_command(
-        "register",
-        {},
-        [&handler, this](const std::string& command, const parameter_list_t&, command_source src){
-            log_dpp("Executing " + command + "...", "Unified Command Handler", ll_info);
-            if (src.issuer.id != owner.id){
-                handler.reply(message("You do not have permission to use this command."), src);
-                return;
-            }
-
-            if (handler.slash_commands_enabled){
-                handler.thinking(src);
-                log_dpp("Registering commands.", "Command Registration", ll_info);
-                handler.register_commands();
-
-                embed embed;
-                std::string desc = "Slash commands registered! Restart your Discord client or wait a few minutes for them to show up!";
-                embed.set_color((uint32_t)color).set_description(desc).set_title("Slash Command Registration");
-                Handler::update_response(src, embed, "", nullptr);
-            }else{
-                handler.reply(message("Enable slash commands before registering them."), src);
-            }
-        },
-        "Register global slash commands. For first-time slash command use and for updating commands.");
+        "View the command list.");
 }
 
-
 }
 }
 }
diff --git a/SerialPrograms/Source/Integrations/DppIntegration/DppCommandHandler.h b/SerialPrograms/Source/Integrations/DppIntegration/DppCommandHandler.h
@@ -5,6 +5,7 @@
 #include <Integrations/DppIntegration/DppUtility.h>
 #include "Common/Cpp/Concurrency/ScheduledTaskRunner.h"
 #include "CommonFramework/Notifications/MessageAttachment.h"
+#include "CommonFramework/GlobalSettingsPanel.h"
 #include "CommonFramework/Tools/GlobalThreadPools.h"
 #include "Integrations/DiscordSettingsOption.h"
 

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,10 @@ DiscordIntegrationSettingsOption::DiscordIntegrationSettingsOption()`
`32`	`32`	`LockMode::LOCK_WHILE_RUNNING,`
`33`	`33`	`false`
`34`	`34`	`)`
	`35`	`+ , register_slash_button(`
	`36`	`+ "<b>Register Slash Commands on Start:</b><br>Only needs to be run once, or after additional commands are added.",`
	`37`	`+ "Register Slash Commands"`
	`38`	`+ )`
`35`	`39`	`, command_type(`
`36`	`40`	`"<b>Discord Integration Command Type:</b><br>Restart the program for this to take effect.",`
`37`	`41`	`{`
`@@ -72,6 +76,7 @@ DiscordIntegrationSettingsOption::DiscordIntegrationSettingsOption()`
`72`	`76`	`)`
`73`	`77`	`{`
`74`	`78`	`PA_ADD_OPTION(run_on_start);`
	`79`	`+ PA_ADD_OPTION(register_slash_button);`
`75`	`80`	`PA_ADD_OPTION(command_type);`
`76`	`81`	`PA_ADD_OPTION(token);`
`77`	`82`	`PA_ADD_OPTION(command_prefix);`