Merge pull request #271 from Rustmail/267-rework-snippet-command

Akinator31 · web-flow · commit d06d66d808fd · 2025-12-03T22:44:26.000+01:00
refactor(snippet): implement 'use' subcommand to be more user-friendly
diff --git a/rustmail/src/commands/snippet/slash_command/snippet.rs b/rustmail/src/commands/snippet/slash_command/snippet.rs
@@ -95,6 +95,15 @@ impl RegistrableCommand for SnippetCommand {
                 None,
             )
             .await;
+            let use_desc = get_translated_message(
+                &config,
+                "slash_command.snippet_use_description",
+                None,
+                None,
+                None,
+                None,
+            )
+            .await;
             let key_desc = get_translated_message(
                 &config,
                 "slash_command.snippet_key_argument",
@@ -181,6 +190,17 @@ impl RegistrableCommand for SnippetCommand {
                             "delete",
                             delete_desc,
                         )
+                        .add_sub_option(
+                            CreateCommandOption::new(CommandOptionType::String, "key", key_desc.clone())
+                                .required(true),
+                        ),
+                    )
+                    .add_option(
+                        CreateCommandOption::new(
+                            CommandOptionType::SubCommand,
+                            "use",
+                            use_desc,
+                        )
                         .add_sub_option(
                             CreateCommandOption::new(CommandOptionType::String, "key", key_desc)
                                 .required(true),
@@ -223,6 +243,9 @@ impl RegistrableCommand for SnippetCommand {
                 "delete" => {
                     handle_delete(&ctx, &command, &command.data.options, pool, &config).await
                 }
+                "use" => {
+                    handle_use(&ctx, &command, &command.data.options, pool, &config).await
+                }
                 _ => {
                     let response = MessageBuilder::system_message(&ctx, &config)
                         .translated_content(
@@ -558,3 +581,81 @@ async fn handle_delete(
 
     Ok(())
 }
+
+async fn handle_use(
+    ctx: &Context,
+    command: &CommandInteraction,
+    options: &Vec<CommandDataOption>,
+    pool: &sqlx::SqlitePool,
+    config: &Config,
+) -> ModmailResult<()> {
+    let mut key = String::new();
+
+    if let Some(subcommand) = options.first() {
+        if let CommandDataOptionValue::SubCommand(sub_options) = &subcommand.value {
+            for option in sub_options {
+                if option.name == "key" {
+                    if let CommandDataOptionValue::String(val) = &option.value {
+                        key = val.to_string();
+                    }
+                }
+            }
+        }
+    }
+
+    match get_snippet_by_key(&key, pool).await? {
+        Some(snippet) => {
+            let thread = get_thread_by_channel_id(&command.channel_id.to_string(), pool).await;
+
+            if let Some(thread) = thread {
+                let user_id = serenity::all::UserId::new(thread.user_id as u64);
+
+                use crate::utils::message::message_builder::StaffReply;
+
+                let message_number = allocate_next_message_number(&thread.id, pool).await?;
+
+                StaffReply::new(
+                    ctx,
+                    config,
+                    thread.id.clone(),
+                    command.user.id,
+                    command.user.name.clone(),
+                    message_number,
+                )
+                .to_thread(command.channel_id)
+                .to_user(user_id)
+                .content(snippet.content)
+                .send_command_and_record(command, pool)
+                .await?;
+
+                let response = MessageBuilder::system_message(ctx, config)
+                    .translated_content(
+                        "snippet.used",
+                        Some(&HashMap::from([("key".to_string(), key.clone())])),
+                        Some(command.user.id),
+                        command.guild_id.map(|g| g.get()),
+                    )
+                    .await
+                    .ephemeral(true)
+                    .build_interaction_message_followup()
+                    .await;
+
+                command.create_followup(&ctx.http, response).await?;
+            } else {
+                let response = MessageBuilder::system_message(ctx, config)
+                    .content(&snippet.content)
+                    .build_interaction_message_followup()
+                    .await;
+
+                command.create_followup(&ctx.http, response).await?;
+            }
+        }
+        None => {
+            return Err(ModmailError::Command(CommandError::SnippetNotFound(
+                key.to_string(),
+            )));
+        }
+    }
+
+    Ok(())
+}
diff --git a/rustmail/src/commands/snippet/text_command/snippet.rs b/rustmail/src/commands/snippet/text_command/snippet.rs
@@ -20,7 +20,7 @@ pub async fn snippet_command(
         .as_ref()
         .ok_or_else(database_connection_failed)?;
 
-    let content = match extract_reply_content(&msg.content, &config.command.prefix, &["snippet"]) {
+    let content = match extract_reply_content(&msg.content, &config.command.prefix, &["snippet", "s"]) {
         Some(c) => c,
         None => {
             MessageBuilder::system_message(&ctx, config)
@@ -49,18 +49,7 @@ pub async fn snippet_command(
         "edit" => handle_edit(&ctx, &msg, args, pool, config).await,
         "delete" => handle_delete(&ctx, &msg, args, pool, config).await,
         _ => {
-            MessageBuilder::system_message(&ctx, config)
-                .translated_content(
-                    "snippet.unknown_text_subcommand",
-                    None,
-                    Some(msg.author.id),
-                    msg.guild_id.map(|g| g.get()),
-                )
-                .await
-                .reply_to(msg)
-                .send(true)
-                .await?;
-            Ok(())
+            handle_use(&ctx, &msg, subcommand, pool, config).await
         }
     }
 }
@@ -72,9 +61,17 @@ async fn handle_create(
     pool: &sqlx::SqlitePool,
     config: &Config,
 ) -> ModmailResult<()> {
-    let mut parts = args.splitn(2, ' ');
-    let key = parts.next().unwrap_or("").trim();
-    let content = parts.next().unwrap_or("").trim();
+    let trimmed_args = args.trim_start();
+    let split_pos = trimmed_args
+        .find(|c: char| c.is_whitespace())
+        .unwrap_or(trimmed_args.len());
+
+    let key = trimmed_args[..split_pos].trim();
+    let content = if split_pos < trimmed_args.len() {
+        &trimmed_args[split_pos + 1..]
+    } else {
+        ""
+    };
 
     if key.is_empty() || content.is_empty() {
         MessageBuilder::system_message(ctx, config)
@@ -267,9 +264,17 @@ async fn handle_edit(
     pool: &sqlx::SqlitePool,
     config: &Config,
 ) -> ModmailResult<()> {
-    let mut parts = args.splitn(2, ' ');
-    let key = parts.next().unwrap_or("").trim();
-    let content = parts.next().unwrap_or("").trim();
+    let trimmed_args = args.trim_start();
+    let split_pos = trimmed_args
+        .find(|c: char| c.is_whitespace())
+        .unwrap_or(trimmed_args.len());
+
+    let key = trimmed_args[..split_pos].trim();
+    let content = if split_pos < trimmed_args.len() {
+        &trimmed_args[split_pos + 1..]
+    } else {
+        ""
+    };
 
     if key.is_empty() || content.is_empty() {
         MessageBuilder::system_message(ctx, config)
@@ -367,3 +372,67 @@ async fn handle_delete(
 
     Ok(())
 }
+
+async fn handle_use(
+    ctx: &Context,
+    msg: &Message,
+    key: &str,
+    pool: &sqlx::SqlitePool,
+    config: &Config,
+) -> ModmailResult<()> {
+    if key.is_empty() {
+        MessageBuilder::system_message(ctx, config)
+            .translated_content(
+                "snippet.text_usage",
+                None,
+                Some(msg.author.id),
+                msg.guild_id.map(|g| g.get()),
+            )
+            .await
+            .reply_to(msg.clone())
+            .send(true)
+            .await?;
+        return Ok(());
+    }
+
+    match get_snippet_by_key(key, pool).await? {
+        Some(snippet) => {
+            let thread = get_thread_by_channel_id(&msg.channel_id.to_string(), pool).await;
+
+            if let Some(thread) = thread {
+                let user_id = serenity::all::UserId::new(thread.user_id as u64);
+
+                use crate::utils::message::message_builder::StaffReply;
+
+                let message_number = allocate_next_message_number(&thread.id, pool).await?;
+
+                StaffReply::new(
+                    ctx,
+                    config,
+                    thread.id.clone(),
+                    msg.author.id,
+                    msg.author.name.clone(),
+                    message_number,
+                )
+                .to_thread(msg.channel_id)
+                .to_user(user_id)
+                .content(snippet.content)
+                .send_msg_and_record(pool)
+                .await?;
+            } else {
+                MessageBuilder::system_message(ctx, config)
+                    .content(&snippet.content)
+                    .reply_to(msg.clone())
+                    .send(true)
+                    .await?;
+            }
+        }
+        None => {
+            return Err(ModmailError::Command(CommandError::SnippetNotFound(
+                key.to_string(),
+            )));
+        }
+    }
+
+    Ok(())
+}
diff --git a/rustmail/src/handlers/guild_messages_handler.rs b/rustmail/src/handlers/guild_messages_handler.rs
@@ -78,7 +78,7 @@ impl GuildMessagesHandler {
         wrap_command!(lock, "take", take);
         wrap_command!(lock, "release", release);
         wrap_command!(lock, "ping", ping);
-        wrap_command!(lock, "snippet", snippet_command);
+        wrap_command!(lock, ["snippet", "s"], snippet_command);
 
         drop(lock);
         h
diff --git a/rustmail/src/i18n/language/en.rs b/rustmail/src/i18n/language/en.rs
@@ -981,10 +981,11 @@ pub fn load_english_messages(dict: &mut ErrorDictionary) {
             • `/snippet list` - List all available snippets\n\
             • `/snippet show <key>` - Display a specific snippet's content\n\
             • `/snippet edit <key> <content>` - Update an existing snippet\n\
-            • `/snippet delete <key>` - Delete a snippet\n\n\
-            **Usage:**\n\
-            • Slash command: `/reply snippet:<key>`\n\
-            • Text command: `!reply {{key}}`",
+            • `/snippet delete <key>` - Delete a snippet\n\
+            • `/snippet use <key>` - Use a snippet to reply\n\n\
+            **Quick usage:**\n\
+            • Slash command: `/snippet use <key>` or `/reply snippet:<key>`\n\
+            • Text command: `!snippet <key>` or `!reply {{key}}`",
         ),
     );
     dict.messages.insert(
@@ -1007,6 +1008,10 @@ pub fn load_english_messages(dict: &mut ErrorDictionary) {
         "slash_command.snippet_delete_description".to_string(),
         DictionaryMessage::new("Delete a snippet"),
     );
+    dict.messages.insert(
+        "slash_command.snippet_use_description".to_string(),
+        DictionaryMessage::new("Use a snippet to reply in a ticket"),
+    );
     dict.messages.insert(
         "slash_command.snippet_key_argument".to_string(),
         DictionaryMessage::new("Snippet key (alphanumeric, dashes, underscores)"),
@@ -1116,4 +1121,8 @@ pub fn load_english_messages(dict: &mut ErrorDictionary) {
             "Unknown subcommand. Use: `create`, `list`, `show`, `edit`, or `delete`",
         ),
     );
+    dict.messages.insert(
+        "snippet.used".to_string(),
+        DictionaryMessage::new("Snippet '**{key}**' used successfully!"),
+    );
 }
diff --git a/rustmail/src/i18n/language/fr.rs b/rustmail/src/i18n/language/fr.rs
@@ -992,10 +992,11 @@ pub fn load_french_messages(dict: &mut ErrorDictionary) {
             • `/snippet list` - Lister tous les snippets disponibles\n\
             • `/snippet show <clé>` - Afficher le contenu d'un snippet spécifique\n\
             • `/snippet edit <clé> <contenu>` - Modifier un snippet existant\n\
-            • `/snippet delete <clé>` - Supprimer un snippet\n\n\
-            **Utilisation :**\n\
-            • Commande slash : `/reply snippet:<clé>`\n\
-            • Commande texte : `!reply {{clé}}`",
+            • `/snippet delete <clé>` - Supprimer un snippet\n\
+            • `/snippet use <clé>` - Utiliser un snippet pour répondre\n\n\
+            **Utilisation rapide :**\n\
+            • Commande slash : `/snippet use <clé>` ou `/reply snippet:<clé>`\n\
+            • Commande texte : `!snippet <clé>` ou `!reply {{clé}}`",
         ),
     );
     dict.messages.insert(
@@ -1018,6 +1019,10 @@ pub fn load_french_messages(dict: &mut ErrorDictionary) {
         "slash_command.snippet_delete_description".to_string(),
         DictionaryMessage::new("Supprimer un snippet"),
     );
+    dict.messages.insert(
+        "slash_command.snippet_use_description".to_string(),
+        DictionaryMessage::new("Utiliser un snippet pour répondre dans un ticket"),
+    );
     dict.messages.insert(
         "slash_command.snippet_key_argument".to_string(),
         DictionaryMessage::new("Clé du snippet (alphanumériques, tirets, underscores)"),
@@ -1129,4 +1134,8 @@ pub fn load_french_messages(dict: &mut ErrorDictionary) {
             "Sous-commande inconnue. Utilisez : `create`, `list`, `show`, `edit`, ou `delete`",
         ),
     );
+    dict.messages.insert(
+        "snippet.used".to_string(),
+        DictionaryMessage::new("Snippet '**{key}**' utilisé avec succès !"),
+    );
 }

Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ impl GuildMessagesHandler {`
`78`	`78`	`wrap_command!(lock, "take", take);`
`79`	`79`	`wrap_command!(lock, "release", release);`
`80`	`80`	`wrap_command!(lock, "ping", ping);`
`81`		`- wrap_command!(lock, "snippet", snippet_command);`
	`81`	`+ wrap_command!(lock, ["snippet", "s"], snippet_command);`
`82`	`82`
`83`	`83`	`drop(lock);`
`84`	`84`	`h`