More newline escaping for slash command params

Author: benthetechguy

TSCppBot.db.example

@@ -92,6 +92,8 @@ dpp::task<> db_commands::add_text_command(const dpp::form_submit_t &event, const
     command.description = std::get<std::string>(event.components[1].components[0].value);
     command.value = std::get<std::string>(event.components[2].components[0].value);
     command.global = (std::get<std::string>(event.components[3].components[0].value) == "true");
+    // Replace escaped newline "\n" in description with actual newline character
+    util::escape_newlines(command.description);
 
     // Build command SQL row
     std::string name = util::sql_escape_string(command_name);

src/command_modules/db_commands.cpp

@@ -48,15 +48,7 @@ dpp::task<> meta::send_message(const dpp::slashcommand_t &event) {
     dpp::async thinking = event.co_thinking(true);
     // Replace escaped newline "\n" with actual newline character
     std::string message = std::get<std::string>(event.get_parameter("message"));
-    size_t pos = message.find("\\n");
-    while (pos < message.size() && pos != std::string::npos) {
-        // Don't replace if "\\n" is sent (double escape)
-        if (message[pos - 1] != '\\') {
-            message.replace(pos, 2, "\n");
-        }
-        // Find next occurence, if any
-        pos = message.find("\\n", pos + 1);
-    }
+    util::escape_newlines(message);
     // Send message
     dpp::confirmation_callback_t msg_conf = co_await event.owner->co_message_create(dpp::message(event.command.channel_id, message));
     co_await thinking;
@@ -72,15 +64,7 @@ dpp::task<> meta::announce(const dpp::slashcommand_t &event, const nlohmann::jso
     dpp::async thinking = event.co_thinking(true);
     // Replace escaped newline "\\n" with actual newline character
     std::string message = std::get<std::string>(event.get_parameter("message"));
-    size_t pos = message.find("\\n");
-    while (pos < message.size() && pos != std::string::npos) {
-        // Don't replace if "\\n" is sent (double escape)
-        if (message[pos - 1] != '\\') {
-            message.replace(pos, 2, "\n");
-        }
-        // Find next occurence, if any
-        pos = message.find("\\n", pos + 1);
-    }
+    util::escape_newlines(message);
 
     dpp::embed embed = dpp::embed().set_color(util::color::DEFAULT).
     set_description(message);
@@ -116,6 +100,9 @@ dpp::task<> meta::dm(const dpp::slashcommand_t &event, const nlohmann::json &con
     // Get user and message, construct embed, and send DM
     dpp::user user = event.command.get_resolved_user(std::get<dpp::snowflake>(event.get_parameter("user")));
     std::string message = std::get<std::string>(event.get_parameter("message"));
+    // Replace escaped newline "\\n" with actual newline character
+    util::escape_newlines(message);
+
     dpp::embed dm_embed = dpp::embed().set_color(util::color::DEFAULT).set_title("Message from the owners of TSC").set_description(message);
     dpp::confirmation_callback_t confirmation = co_await event.owner->co_direct_message_create(user.id, dpp::message(dm_embed));
     if (confirmation.is_error()) {
@@ -154,6 +141,8 @@ void meta::remindme(const dpp::slashcommand_t &event, sqlite3* db) {
     reminder.user = event.command.get_issuing_user().id;
     try {
         reminder.text = std::get<std::string>(event.get_parameter("reminder"));
+        // Replace escaped newline "\\n" with actual newline character
+        util::escape_newlines(reminder.text);
     } catch (const std::bad_variant_access&) {
         reminder.text = "No description provided.";
     }

src/command_modules/meta.cpp

@@ -71,6 +71,8 @@ dpp::task<> moderation::purge(const dpp::slashcommand_t &event, const nlohmann::
                                       .add_field("In channel", channel.get_mention(), true);
     try {
         std::string reason = std::get<std::string>(event.get_parameter("reason"));
+        // Replace escaped newline "\\n" with actual newline character
+        util::escape_newlines(reason);
         embed.add_field("Reason", reason, false);
     } catch (const std::bad_variant_access&) {}
     event.owner->message_create(dpp::message(config["log_channel_ids"]["mod_log"], embed));
@@ -198,6 +200,8 @@ dpp::task<> moderation::warn(const dpp::slashcommand_t &event, const nlohmann::j
         co_return;
     }
     std::string reason = std::get<std::string>(event.get_parameter("reason"));
+    // Replace escaped newline "\\n" with actual newline character
+    util::escape_newlines(reason);
     // Check hierarchy
     if (! co_await util::check_perms(event.owner, config, event.command.get_issuing_user().id, user.user_id)) {
         co_await thinking;
@@ -256,6 +260,8 @@ dpp::task<> moderation::unwarn(const dpp::slashcommand_t &event, const nlohmann:
     // Send "thinking" response to allow time for DB operation
     dpp::async thinking = event.co_thinking(true);
     std::string reason = std::get<std::string>(event.get_parameter("reason"));
+    // Replace escaped newline "\\n" with actual newline character
+    util::escape_newlines(reason);
     // Get ID and make sure it's a number
     std::string id = std::get<std::string>(event.get_parameter("id"));
     if (std::ranges::any_of(id, [](const char& c){return !std::isdigit(c);})) {
@@ -364,6 +370,8 @@ dpp::task<> moderation::mute(const dpp::slashcommand_t &event, const nlohmann::j
     std::string reason;
     try {
         reason = std::get<std::string>(event.get_parameter("reason"));
+        // Replace escaped newline "\\n" with actual newline character
+        util::escape_newlines(reason);
     } catch (const std::bad_variant_access&) {
         reason = "No reason provided.";
     }
@@ -466,6 +474,8 @@ dpp::task<> moderation::unmute(const dpp::slashcommand_t &event, const nlohmann:
     std::string reason;
     try {
         reason = std::get<std::string>(event.get_parameter("reason"));
+        // Replace escaped newline "\\n" with actual newline character
+        util::escape_newlines(reason);
     } catch (const std::bad_variant_access&) {
         reason = "No reason provided.";
     }
@@ -551,6 +561,8 @@ dpp::task<> moderation::kick(const dpp::slashcommand_t &event, const nlohmann::j
     std::string reason;
     try {
         reason = std::get<std::string>(event.get_parameter("reason"));
+        // Replace escaped newline "\\n" with actual newline character
+        util::escape_newlines(reason);
     } catch (const std::bad_variant_access&) {
         reason = "No reason provided.";
     }
@@ -627,6 +639,8 @@ dpp::task<> moderation::ban(const dpp::slashcommand_t &event, const nlohmann::js
     std::string reason;
     try {
         reason = std::get<std::string>(event.get_parameter("reason"));
+        // Replace escaped newline "\\n" with actual newline character
+        util::escape_newlines(reason);
     } catch (const std::bad_variant_access&) {
         reason = "No reason provided.";
     }
@@ -720,6 +734,8 @@ dpp::task<> moderation::unban(const dpp::slashcommand_t &event, const nlohmann::
     std::string reason;
     try {
         reason = std::get<std::string>(event.get_parameter("reason"));
+        // Replace escaped newline "\\n" with actual newline character
+        util::escape_newlines(reason);
     } catch (const std::bad_variant_access&) {
         reason = "No reason provided.";
     }

src/command_modules/moderation.cpp

@@ -40,6 +40,9 @@ void server_info::rule(const dpp::slashcommand_t &event, const nlohmann::json &c
 
 void server_info::suggest(const dpp::slashcommand_t &event, const nlohmann::json &config) {
     std::string suggestion = std::get<std::string>(event.get_parameter("suggestion"));
+    // Replace escaped newline "\n" with actual newline character
+    util::escape_newlines(suggestion);
+
     dpp::embed_author author(event.command.member.get_nickname(), "", event.command.member.get_avatar_url());
     dpp::embed embed = dpp::embed().set_color(dpp::colors::light_gray).set_author(author)
     .set_description(std::string("**Suggestion:** ") + suggestion).add_field("Status: Pending", "");
@@ -77,6 +80,8 @@ dpp::task<> server_info::suggestion_response(const dpp::slashcommand_t &event, c
         message.embeds[0].fields[0].name = "Status: Declined";
     }
     message.embeds[0].fields[0].value = std::get<std::string>(event.get_parameter("response"));
+    // Replace escaped newline "\\n" with actual newline character
+    util::escape_newlines(message.embeds[0].fields[0].value);
 
     event.owner->message_edit(message);
     co_await thinking;

src/command_modules/server_info.cpp

@@ -133,6 +133,18 @@ std::string util::sql_escape_string(const std::string_view str, const bool wrap_
     return escaped_str;
 }
 
+void util::escape_newlines(std::string& str) {
+    size_t pos = str.find("\\n");
+    while (pos != std::string::npos) {
+        // Don't replace if "\\n" is sent (double escape)
+        if (str[pos - 1] != '\\') {
+            str.replace(pos, 2, "\n");
+        }
+        // Find next occurence, if any
+        pos = str.find("\\n", pos + 1);
+    }
+}
+
 bool util::is_valid_command_name(const std::string_view command_name) {
     bool valid = true;
     for (char c : command_name) {

src/util.cpp

@@ -260,6 +260,13 @@ namespace util {
      */
     std::string sql_escape_string(std::string_view str, bool wrap_single_quotes = false);
 
+    /**
+     * Replace literal "\n" in strings with actual newline character.
+     * This is needed for slash command parameters because Discord only allows one line in a parameter.
+     * @param str String to replace newlines in
+     */
+    void escape_newlines(std::string& str);
+
     /**
      * Check if a string would be a valid Discord slash command name
      * @param command_name Proposed command name