Change DJ role check to be a serenity check

Signed-off-by: trivernis <trivernis@protonmail.com>

src/commands/music/clear_queue.rs

@@ -4,7 +4,7 @@ use serenity::framework::standard::CommandResult;
 use serenity::model::channel::Message;
 
 use crate::commands::common::handle_autodelete;
-use crate::commands::music::{get_queue_for_guild, is_dj};
+use crate::commands::music::{get_queue_for_guild, DJ_CHECK};
 use bot_serenityutils::core::SHORT_TIMEOUT;
 use bot_serenityutils::ephemeral_message::EphemeralMessage;
 
@@ -14,13 +14,9 @@ use bot_serenityutils::ephemeral_message::EphemeralMessage;
 #[usage("")]
 #[aliases("cq", "clear-queue", "clearqueue")]
 #[bucket("general")]
+#[checks(DJ)]
 async fn clear_queue(ctx: &Context, msg: &Message) -> CommandResult {
     let guild = msg.guild(&ctx.cache).await.unwrap();
-
-    if !is_dj(ctx, guild.id, &msg.author).await? {
-        msg.channel_id.say(ctx, "Requires DJ permissions").await?;
-        return Ok(());
-    }
     log::debug!("Clearing queue for guild {}", guild.id);
 
     let queue = forward_error!(

src/commands/music/leave.rs

@@ -4,7 +4,7 @@ use serenity::framework::standard::CommandResult;
 use serenity::model::channel::Message;
 
 use crate::commands::common::handle_autodelete;
-use crate::commands::music::{get_voice_manager, is_dj};
+use crate::commands::music::{get_voice_manager, DJ_CHECK};
 use crate::utils::context_data::Store;
 use bot_serenityutils::core::SHORT_TIMEOUT;
 use bot_serenityutils::ephemeral_message::EphemeralMessage;
@@ -15,13 +15,10 @@ use bot_serenityutils::ephemeral_message::EphemeralMessage;
 #[usage("")]
 #[aliases("stop")]
 #[bucket("general")]
+#[checks(DJ)]
 async fn leave(ctx: &Context, msg: &Message) -> CommandResult {
     let guild = msg.guild(&ctx.cache).await.unwrap();
     log::debug!("Leave request received for guild {}", guild.id);
-    if !is_dj(ctx, guild.id, &msg.author).await? {
-        msg.channel_id.say(ctx, "Requires DJ permissions").await?;
-        return Ok(());
-    }
 
     let manager = get_voice_manager(ctx).await;
     let queue = {

src/commands/music/mod.rs

@@ -3,10 +3,11 @@ use std::sync::atomic::{AtomicIsize, AtomicUsize, Ordering};
 use std::sync::Arc;
 use std::time::Duration;
 
+use aspotify::Track;
 use regex::Regex;
 use serenity::async_trait;
 use serenity::client::Context;
-use serenity::framework::standard::macros::group;
+use serenity::framework::standard::macros::{check, group};
 use serenity::http::Http;
 use serenity::model::channel::Message;
 use serenity::model::guild::Guild;
@@ -39,8 +40,8 @@ use crate::providers::music::{add_youtube_song_to_database, youtube_dl};
 use crate::providers::settings::{get_setting, Setting};
 use crate::utils::context_data::{DatabaseContainer, Store};
 use crate::utils::error::{BotError, BotResult};
-use aspotify::Track;
 use bot_database::Database;
+use serenity::framework::standard::{Args, CommandOptions, Reason};
 
 mod clear_queue;
 mod current;
@@ -415,6 +416,29 @@ async fn added_multiple_msg(ctx: &Context, msg: &Message, songs: &mut Vec<Song>)
     Ok(())
 }
 
+#[check]
+#[name = "DJ"]
+pub async fn check_dj(
+    ctx: &Context,
+    msg: &Message,
+    _: &mut Args,
+    _: &CommandOptions,
+) -> Result<(), Reason> {
+    let guild = msg
+        .guild(&ctx.cache)
+        .await
+        .ok_or(Reason::Log("Not in a guild".to_string()))?;
+
+    if is_dj(ctx, guild.id, &msg.author)
+        .await
+        .map_err(|e| Reason::Log(format!("{:?}", e)))?
+    {
+        Ok(())
+    } else {
+        Err(Reason::User("Lacking DJ role".to_string()))
+    }
+}
+
 /// Returns if the given user is a dj in the given guild based on the
 /// setting for the name of the dj role
 pub async fn is_dj(ctx: &Context, guild: GuildId, user: &User) -> BotResult<bool> {

src/commands/music/move_song.rs

@@ -1,5 +1,5 @@
 use crate::commands::common::handle_autodelete;
-use crate::commands::music::{get_queue_for_guild, is_dj};
+use crate::commands::music::{get_queue_for_guild, DJ_CHECK};
 use bot_serenityutils::core::SHORT_TIMEOUT;
 use bot_serenityutils::ephemeral_message::EphemeralMessage;
 use serenity::client::Context;
@@ -11,11 +11,11 @@ use serenity::model::channel::Message;
 #[description("Moves a song in the queue from one position to a new one")]
 #[usage("<old-pos> <new-pos>")]
 #[example("102 2")]
-#[min_args(2)]
-#[max_args(2)]
+#[num_args(2)]
 #[bucket("general")]
 #[only_in(guilds)]
 #[aliases("mvs", "movesong", "move-song")]
+#[checks(DJ)]
 async fn move_song(ctx: &Context, msg: &Message, mut args: Args) -> CommandResult {
     let guild = msg.guild(&ctx.cache).await.unwrap();
     log::debug!("Moving song for guild {}", guild.id);
@@ -23,10 +23,6 @@ async fn move_song(ctx: &Context, msg: &Message, mut args: Args) -> CommandResul
     let pos1 = args.single::<usize>()?;
     let pos2 = args.single::<usize>()?;
 
-    if !is_dj(ctx, guild.id, &msg.author).await? {
-        msg.channel_id.say(ctx, "Requires DJ permissions").await?;
-        return Ok(());
-    }
     {
         let queue = forward_error!(
             ctx,

src/commands/music/pause.rs

@@ -4,7 +4,7 @@ use serenity::model::channel::Message;
 use serenity::prelude::*;
 
 use crate::commands::common::handle_autodelete;
-use crate::commands::music::{get_queue_for_guild, is_dj};
+use crate::commands::music::{get_queue_for_guild, DJ_CHECK};
 use crate::messages::music::now_playing::update_now_playing_msg;
 use bot_serenityutils::core::SHORT_TIMEOUT;
 use bot_serenityutils::ephemeral_message::EphemeralMessage;
@@ -14,13 +14,10 @@ use bot_serenityutils::ephemeral_message::EphemeralMessage;
 #[description("Pauses playback")]
 #[usage("")]
 #[bucket("general")]
+#[checks(DJ)]
 async fn pause(ctx: &Context, msg: &Message) -> CommandResult {
     let guild = msg.guild(&ctx.cache).await.unwrap();
     log::debug!("Pausing playback for guild {}", guild.id);
-    if !is_dj(ctx, guild.id, &msg.author).await? {
-        msg.channel_id.say(ctx, "Requires DJ permissions").await?;
-        return Ok(());
-    }
 
     let queue = forward_error!(
         ctx,

src/commands/music/play.rs

@@ -13,7 +13,7 @@ use crate::providers::settings::{get_setting, Setting};
 #[command]
 #[only_in(guilds)]
 #[description("Plays a song in a voice channel")]
-#[usage("(<spotify_url,youtube_url,query>)")]
+#[usage("(<spotify_ur>|<youtube_url>|<query>|pl:<saved_playlist>)")]
 #[min_args(1)]
 #[aliases("p")]
 #[bucket("music_api")]

src/commands/music/play_next.rs

@@ -5,8 +5,8 @@ use serenity::model::channel::Message;
 
 use crate::commands::common::handle_autodelete;
 use crate::commands::music::{
-    get_channel_for_author, get_queue_for_guild, get_songs_for_query, get_voice_manager, is_dj,
-    join_channel, play_next_in_queue,
+    get_channel_for_author, get_queue_for_guild, get_songs_for_query, get_voice_manager,
+    join_channel, play_next_in_queue, DJ_CHECK,
 };
 
 #[command]
@@ -16,15 +16,12 @@ use crate::commands::music::{
 #[min_args(1)]
 #[aliases("pn", "play-next", "playnext")]
 #[bucket("music_api")]
+#[checks(DJ)]
 async fn play_next(ctx: &Context, msg: &Message, args: Args) -> CommandResult {
     let query = args.message();
 
     let guild = msg.guild(&ctx.cache).await.unwrap();
     log::debug!("Playing song as next song for guild {}", guild.id);
-    if !is_dj(ctx, guild.id, &msg.author).await? {
-        msg.channel_id.say(ctx, "Requires DJ permissions").await?;
-        return Ok(());
-    }
     let manager = get_voice_manager(ctx).await;
     let mut handler = manager.get(guild.id);
 

src/commands/music/remove_song.rs

@@ -1,5 +1,5 @@
 use crate::commands::common::handle_autodelete;
-use crate::commands::music::{get_queue_for_guild, is_dj};
+use crate::commands::music::{get_queue_for_guild, DJ_CHECK};
 use bot_serenityutils::core::SHORT_TIMEOUT;
 use bot_serenityutils::ephemeral_message::EphemeralMessage;
 use serenity::client::Context;
@@ -16,16 +16,13 @@ use serenity::model::channel::Message;
 #[bucket("general")]
 #[only_in(guilds)]
 #[aliases("rms", "removesong", "remove-song")]
+#[checks(DJ)]
 async fn remove_song(ctx: &Context, msg: &Message, mut args: Args) -> CommandResult {
     let guild = msg.guild(&ctx.cache).await.unwrap();
     log::debug!("Moving song for guild {}", guild.id);
 
     let pos = args.single::<usize>()?;
 
-    if !is_dj(ctx, guild.id, &msg.author).await? {
-        msg.channel_id.say(ctx, "Requires DJ permissions").await?;
-        return Ok(());
-    }
     {
         let queue = forward_error!(
             ctx,

src/commands/music/save_playlist.rs

@@ -3,7 +3,7 @@ use serenity::framework::standard::macros::command;
 use serenity::framework::standard::{Args, CommandResult};
 use serenity::model::channel::Message;
 
-use crate::commands::music::is_dj;
+use crate::commands::music::DJ_CHECK;
 use crate::utils::context_data::get_database_from_context;
 
 #[command]
@@ -14,13 +14,10 @@ use crate::utils::context_data::get_database_from_context;
 #[min_args(2)]
 #[aliases("add-playlist", "save-playlist")]
 #[bucket("general")]
+#[checks(DJ)]
 async fn save_playlist(ctx: &Context, msg: &Message, mut args: Args) -> CommandResult {
     let guild = msg.guild(&ctx.cache).await.unwrap();
 
-    if !is_dj(ctx, guild.id, &msg.author).await? {
-        msg.channel_id.say(ctx, "Requires DJ permissions").await?;
-        return Ok(());
-    }
     let name: String = args.single().unwrap();
     let url: &str = args.remains().unwrap();
     log::debug!(

src/commands/music/shuffle.rs

@@ -4,7 +4,7 @@ use serenity::framework::standard::CommandResult;
 use serenity::model::channel::Message;
 
 use crate::commands::common::handle_autodelete;
-use crate::commands::music::{get_queue_for_guild, is_dj};
+use crate::commands::music::{get_queue_for_guild, DJ_CHECK};
 use bot_serenityutils::core::SHORT_TIMEOUT;
 use bot_serenityutils::ephemeral_message::EphemeralMessage;
 
@@ -14,14 +14,11 @@ use bot_serenityutils::ephemeral_message::EphemeralMessage;
 #[usage("")]
 #[aliases("sh")]
 #[bucket("general")]
+#[checks(DJ)]
 async fn shuffle(ctx: &Context, msg: &Message) -> CommandResult {
     let guild = msg.guild(&ctx.cache).await.unwrap();
 
     log::debug!("Shuffling queue for guild {}", guild.id);
-    if !is_dj(ctx, guild.id, &msg.author).await? {
-        msg.channel_id.say(ctx, "Requires DJ permissions").await?;
-        return Ok(());
-    }
     let queue = forward_error!(
         ctx,
         msg.channel_id,

src/commands/music/skip.rs

@@ -4,7 +4,7 @@ use serenity::framework::standard::CommandResult;
 use serenity::model::channel::Message;
 
 use crate::commands::common::handle_autodelete;
-use crate::commands::music::{get_queue_for_guild, is_dj};
+use crate::commands::music::{get_queue_for_guild, DJ_CHECK};
 use bot_serenityutils::core::SHORT_TIMEOUT;
 use bot_serenityutils::ephemeral_message::EphemeralMessage;
 
@@ -14,12 +14,9 @@ use bot_serenityutils::ephemeral_message::EphemeralMessage;
 #[usage("")]
 #[aliases("next")]
 #[bucket("general")]
+#[checks(DJ)]
 async fn skip(ctx: &Context, msg: &Message) -> CommandResult {
     let guild = msg.guild(&ctx.cache).await.unwrap();
-    if !is_dj(ctx, guild.id, &msg.author).await? {
-        msg.channel_id.say(ctx, "Requires DJ permissions").await?;
-        return Ok(());
-    }
     log::debug!("Skipping song for guild {}", guild.id);
     let queue = forward_error!(
         ctx,