Merge pull request 'Retrieve Reply information from ExecBodyParams' (#52) from retrieve-reply-details into main

Reviewed-on: #52

src/core/bot_actions.rs

@@ -1,5 +1,4 @@
-
+use twitch_irc::message::{PrivmsgMessage, TwitchUserBasics};
-use twitch_irc::message::PrivmsgMessage;
 use std::sync::Arc;
 use tokio::sync::RwLock;
 
@@ -57,9 +56,68 @@ impl ExecBodyParams {
         requestor_badge_mut
     }
 
+    /// Returns some information about the message that was replied to by the `PrivmsgMessage` contained
+    /// in the `msg` field of this struct.
+    ///
+    /// If that message replied to message return that information in form of `Some<ReplyParent>`.
+    /// Otherwise, return `None`.
+    pub fn get_parent_reply(&self) -> Option<ReplyParent> {
+        let map = &self.msg.source.tags.0;
+        let tags = [
+            "reply-parent-user-id",
+            "reply-parent-user-login",
+            "reply-parent-display-name",
+            "reply-parent-msg-id",
+            "reply-parent-msg-body"
+        ];
 
+        // filter out all tags that do not have content.
+        let tag_contents: Vec<String> = tags.iter().filter_map(|tag| {
+            // if let Some(&Some(ref t)) = map.get(*tag) {
+                if let Some(Some(t)) = map.get(*tag) {
+                Some(t.clone())
+            } else {
+                None
+            }
+        }).collect();
+
+        // if no tags got filtered out return the struct.
+        // else return `None`.
+        if tag_contents.len() == 5 {
+            Some(ReplyParent {
+                sender: TwitchUserBasics {
+                    id: tag_contents[0].clone(),
+                    login: tag_contents[1].clone(),
+                    name: tag_contents[2].clone(),
+                },
+                message_id: tag_contents[3].clone(),
+                message_text: tag_contents[4].clone(),
+                channel_login: self.msg.channel_login.clone(),
+                channel_id: self.msg.channel_id.clone(),
+            })
+        } else {
+            None
+        }
+    }
 }
 
+/// Represents the message a `PrivmsgMessage` replies to.
+/// Similar to a less detailed `PrivmsgMessage`.
+///
+/// This should not be constructed manually but only from calling `get_parent_reply()` on
+/// `ExecBodyParams`.
+///
+/// Fields that will be the same as the `PrivmsgMessage` this was generated from:
+/// - `channel_login`
+/// - `channel_id`
+#[derive(Debug, Clone, PartialEq)]
+pub struct ReplyParent {
+    pub sender: TwitchUserBasics,
+    pub message_id: String,
+    pub message_text: String,
+    pub channel_login: String,
+    pub channel_id: String,
+}
 
 
 pub mod actions_util {

src/core/botlog.rs

@@ -24,11 +24,10 @@ debug = "Checking bot actions",
 pub fn trace(in_msg: &str, in_module: Option<String>, in_prvmsg: Option<&PrivmsgMessage>) {
     let (chnl, chatter) = match in_prvmsg {
         Some(prvmsg) => {
-            //Log::trace(&format!("(#{}) {}: {}", prvmsg.channel_login, prvmsg.sender.name, prvmsg.message_text));
             (
                 Some(prvmsg.channel_login.clone()),
                 Some(prvmsg.sender.name.clone()),
-            ) // <-- Clone fine atm while we're just working with Strings
+            ) 
         }
         None => (None, None),
     };
@@ -45,11 +44,10 @@ pub fn trace(in_msg: &str, in_module: Option<String>, in_prvmsg: Option<&Privmsg
 pub fn debug(in_msg: &str, in_module: Option<String>, in_prvmsg: Option<&PrivmsgMessage>) {
     let (chnl, chatter) = match in_prvmsg {
         Some(prvmsg) => {
-            //Log::trace(&format!("(#{}) {}: {}", prvmsg.channel_login, prvmsg.sender.name, prvmsg.message_text));
             (
                 Some(prvmsg.channel_login.clone()),
                 Some(prvmsg.sender.name.clone()),
-            ) // <-- Clone fine atm while we're just working with Strings
+            ) 
         }
         None => (None, None),
     };
@@ -66,11 +64,10 @@ pub fn debug(in_msg: &str, in_module: Option<String>, in_prvmsg: Option<&Privmsg
 pub fn info(in_msg: &str, in_module: Option<String>, in_prvmsg: Option<&PrivmsgMessage>) {
     let (chnl, chatter) = match in_prvmsg {
         Some(prvmsg) => {
-            //Log::trace(&format!("(#{}) {}: {}", prvmsg.channel_login, prvmsg.sender.name, prvmsg.message_text));
             (
                 Some(prvmsg.channel_login.clone()),
                 Some(prvmsg.sender.name.clone()),
-            ) // <-- Clone fine atm while we're just working with Strings
+            ) 
         }
         None => (None, None),
     };
@@ -87,11 +84,10 @@ pub fn info(in_msg: &str, in_module: Option<String>, in_prvmsg: Option<&PrivmsgM
 pub fn notice(in_msg: &str, in_module: Option<String>, in_prvmsg: Option<&PrivmsgMessage>) {
     let (chnl, chatter) = match in_prvmsg {
         Some(prvmsg) => {
-            //Log::trace(&format!("(#{}) {}: {}", prvmsg.channel_login, prvmsg.sender.name, prvmsg.message_text));
             (
                 Some(prvmsg.channel_login.clone()),
                 Some(prvmsg.sender.name.clone()),
-            ) // <-- Clone fine atm while we're just working with Strings
+            ) 
         }
         None => (None, None),
     };
@@ -108,11 +104,10 @@ pub fn notice(in_msg: &str, in_module: Option<String>, in_prvmsg: Option<&Privms
 pub fn warn(in_msg: &str, in_module: Option<String>, in_prvmsg: Option<&PrivmsgMessage>) {
     let (chnl, chatter) = match in_prvmsg {
         Some(prvmsg) => {
-            //Log::trace(&format!("(#{}) {}: {}", prvmsg.channel_login, prvmsg.sender.name, prvmsg.message_text));
             (
                 Some(prvmsg.channel_login.clone()),
                 Some(prvmsg.sender.name.clone()),
-            ) // <-- Clone fine atm while we're just working with Strings
+            ) 
         }
         None => (None, None),
     };
@@ -129,11 +124,10 @@ pub fn warn(in_msg: &str, in_module: Option<String>, in_prvmsg: Option<&PrivmsgM
 pub fn error(in_msg: &str, in_module: Option<String>, in_prvmsg: Option<&PrivmsgMessage>) {
     let (chnl, chatter) = match in_prvmsg {
         Some(prvmsg) => {
-            //Log::trace(&format!("(#{}) {}: {}", prvmsg.channel_login, prvmsg.sender.name, prvmsg.message_text));
             (
                 Some(prvmsg.channel_login.clone()),
                 Some(prvmsg.sender.name.clone()),
-            ) // <-- Clone fine atm while we're just working with Strings
+            ) 
         }
         None => (None, None),
     };
@@ -154,11 +148,10 @@ pub fn fatal<'a>(
 ) -> &'a str {
     let (chnl, chatter) = match in_prvmsg {
         Some(prvmsg) => {
-            //Log::trace(&format!("(#{}) {}: {}", prvmsg.channel_login, prvmsg.sender.name, prvmsg.message_text));
             (
                 Some(prvmsg.channel_login.clone()),
                 Some(prvmsg.sender.name.clone()),
-            ) // <-- Clone fine atm while we're just working with Strings
+            ) 
         }
         None => (None, None),
     };

src/core/botmodules.rs

@@ -253,7 +253,6 @@ pub async fn init(mgr: Arc<ModulesManager>) {
     // 2. Add the BotAction to ModulesManager
     botc1.add_core_to_modmgr(Arc::clone(&mgr)).await;
     
-    // async fn cmd_disable(bot: BotAR, msg: PrivmsgMessage) {
     async fn cmd_disable(params : ExecBodyParams) {
         /*
             There should be additional validation checks

src/core/chat.rs

@@ -4,7 +4,7 @@ use std::sync::Arc;
 use tokio::sync::Mutex;
 
 use twitch_irc::login::StaticLoginCredentials;
-use twitch_irc::message::PrivmsgMessage;
+use twitch_irc::message::ReplyToMessage;
 use twitch_irc::transport::tcp::{TCPTransport, TLS};
 use twitch_irc::TwitchIRCClient;
 
@@ -35,8 +35,8 @@ pub struct Chat {
 
 
 #[derive(Clone,Debug)] 
-pub enum BotMsgType<'a> {
+pub enum BotMsgType {
-    SayInReplyTo(&'a PrivmsgMessage,String),
+    SayInReplyTo(Channel,String,String), // ( Destination Channel , Message ID to reply to , OutMessage ) // https://docs.rs/twitch-irc/latest/twitch_irc/client/struct.TwitchIRCClient.html#method.say_in_reply_to
     Say(String,String),
     Notif(String), // For Bot Sent Notifications
 }
@@ -59,7 +59,7 @@ impl Chat {
     }
 
     #[async_recursion]
-    pub async fn send_botmsg(&self, msginput: BotMsgType<'async_recursion>, params : ExecBodyParams) {
+    pub async fn send_botmsg(&self, msginput: BotMsgType, params : ExecBodyParams) {
 
         
             
@@ -72,7 +72,6 @@ impl Chat {
 
          */
 
-        
         botlog::trace(
             format!("send_bot_msg params : {:?}",msginput).as_str(),
             Some("chat.rs > send_botmsg ".to_string()),
@@ -80,9 +79,11 @@ impl Chat {
         );
         Log::flush();
         
+
         let (channel_login,mut outmsg) = match msginput.clone() {
-            BotMsgType::SayInReplyTo(msg, outmsg) => {
+            BotMsgType::SayInReplyTo(chnl, _, outmsg) => {
-                (msg.channel_login.clone(),outmsg)
+                (chnl.0.to_lowercase(), // Desintation Channel
+                    outmsg)
             },
             BotMsgType::Say(a,b ) => {
                 (a.clone(),b.clone())
@@ -113,13 +114,15 @@ impl Chat {
             ).await;
 
         if !params.bot.read().await.bot_channels.contains(&Channel(channel_login.clone())) {
+
+            dbg!("ISSUE : NONJOINED CHANNEL",&params.bot.read().await.bot_channels,Channel(channel_login.clone()));
             botlog::warn(
                 &format!("A message attempted to send for a Non-Joined Channel : {}",channel_login.clone()),
                 Some("Chat > send_botmsg".to_string()),
                 None,
             );
 
-            if let BotMsgType::SayInReplyTo(_prvmsg,_outmsg) = msginput {
+            if let BotMsgType::SayInReplyTo(_chnl,_msgid, _outmsg) = msginput {
 
                 self.send_botmsg(BotMsgType::Notif(
                     "uuh Bot can't send to a channel it isn't joined".to_string(), 
@@ -167,7 +170,7 @@ impl Chat {
 
             match msginput {
                 BotMsgType::Notif(_) => (), // Do nothing with Notif > We'll validate the user later to handle
-                BotMsgType::SayInReplyTo(_, _) | BotMsgType::Say(_,_) => {
+                BotMsgType::SayInReplyTo(_, _, _) | BotMsgType::Say(_,_) => {
                             
                         botlog::trace(
                             "BEFORE potential Async recursion",
@@ -232,7 +235,7 @@ impl Chat {
              let botlock = botclone.read().await;
              let id = botlock.get_identity();
              let id = Arc::clone(&id);
-             let idlock = id.read().await; // <-- [x] 03.24 - seems to work
+             let idlock = id.read().await; 
              let user_roles = idlock.getspecialuserroles(
                 params.get_sender(), 
                 Some(Channel(channel_login.clone()))
@@ -266,7 +269,7 @@ impl Chat {
                             return;
                         }
                     },
-                    BotMsgType::SayInReplyTo(_,_ ) | BotMsgType::Say(_,_) => {
+                    BotMsgType::SayInReplyTo(_,_,_ ) | BotMsgType::Say(_,_) => {
                         // If the BotMsg a Say/SayInReplyTo (from Developer or Chatter) , and the Sender does not have Specific Roles in the Source Channel Sent
 
                         self.send_botmsg(BotMsgType::Notif(
@@ -320,7 +323,6 @@ impl Chat {
         );
 
         let contextratelimiter = rllock
-            // .get_mut()
             .get_mut(&Channel(channel_login.to_lowercase().clone()))
             .expect("ERROR: Issue with Rate limiters");
 
@@ -339,13 +341,21 @@ impl Chat {
                 }
 
                 match msginput.clone() {
-                    BotMsgType::SayInReplyTo(msg, _) => {
+                    BotMsgType::SayInReplyTo(chnl,msgid, _) => {
-                        self.client.say_in_reply_to(msg, outmsg).await.unwrap();
+
+                        dbg!(chnl.clone(),msgid.clone(),outmsg.clone());
+
+                        self.client.say_in_reply_to(&(
+                            chnl.0,
+                            msgid), 
+                            outmsg).await.unwrap();
                     },
                     BotMsgType::Say(a, _) => {
                         self.client.say(a, outmsg).await.unwrap();
                     }
                     BotMsgType::Notif(outmsg) => {
+
+                        dbg!(params.msg.channel_login(),params.msg.message_id());
                         self.client.say_in_reply_to(&params.msg, outmsg).await.unwrap();
                     }
                 }
@@ -357,11 +367,11 @@ impl Chat {
                     channel_login.clone(), "rate limit counter increase", contextratelimiter
                 );
 
-                if let BotMsgType::SayInReplyTo(msg,_ ) = msginput {
+                if let BotMsgType::SayInReplyTo(_,_,_ ) = msginput {
                     botlog::trace(
                         logstr.as_str(),
                         Some("Chat > send_botmsg".to_string()),
-                        Some(msg),
+                        None,
                     );
                 } else {
                     botlog::trace(
@@ -387,73 +397,49 @@ impl Chat {
     }
 
 
+    pub async fn say_in_reply(
+        &self, 
+        destination_channel : Channel , 
+        outmsg: String , 
+        params : ExecBodyParams) 
+    {
 
-    // pub async fn say_in_reply_to(&self, msg: &PrivmsgMessage, outmsg: String) {
+        self.send_botmsg(BotMsgType::SayInReplyTo(
-    // #[async_recursion]
+            destination_channel,
-    pub async fn say_in_reply_to(&self, msg: &PrivmsgMessage, outmsg: String , params : ExecBodyParams) {
+            params.msg.message_id().to_string(), 
+            outmsg) , params).await;
 
-        // let params_clone = params.clone();
-
-        // let botclone = Arc::clone(&params_clone.bot);
-        // let botlock = botclone.read().await;
-        // let id = botlock.get_identity();
-        // let id = Arc::clone(&id);
-
-        // // botlog::trace(
-        // //     "ACQUIRING WRITE LOCK : ID",
-        // //     Some("Chat > send_botmsg".to_string()),
-        // //     Some(&params.msg),
-        // // );
-        // // Log::flush();
-
-        // botlog::trace(
-        //     "ACQUIRING READ LOCK : ID",
-        //     Some("Chat > send_botmsg".to_string()),
-        //     Some(&params.msg),
-        // );
-        // Log::flush();
-
-        
-        // // let idlock = id.write().await; // <-- [ ] 03.24 - This is definitely locking it
-        // let idlock = id.read().await; // <-- [ ] 03.24 - seems to work
-        // let a = idlock.getspecialuserroles(params.get_sender(), Some(Channel(msg.channel_login.clone()))).await;
-        // botlog::trace(
-        //     format!("GETSPECIALUSERROLES RESULT : {:?}",a).as_str(),
-        //     Some("Chat > send_botmsg".to_string()),
-        //     Some(&params.msg),
-        // );
-        // Log::flush();
-        
-        
-
-        // // botlog::trace(
-        // //     "ACQUIRED WRITE LOCK : ID",
-        // //     Some("Chat > send_botmsg".to_string()),
-        // //     Some(&params.msg),
-        // // );
-        // // Log::flush();
-
-
-        
-        // botlog::trace(
-        //     "ACQUIRED READ LOCK : ID",
-        //     Some("Chat > send_botmsg".to_string()),
-        //     Some(&params.msg),
-        // );
-        // Log::flush();
-
-
-        self.send_botmsg(BotMsgType::SayInReplyTo(msg, outmsg) , params).await;
 
     }
 
-    // pub async fn say(&self, channel_login: String, message: String) {
+    pub async fn say_in_reply_to(
+        &self, 
+        destination_channel : Channel , 
+        reply_message_id : String ,
+        outmsg: String , 
+        params : ExecBodyParams) 
+    {
+
+        self.send_botmsg(BotMsgType::SayInReplyTo(
+                destination_channel,
+                reply_message_id, 
+                outmsg) , params).await;
+
+    }
+
+
+
+
     pub async fn say(&self, channel_login: String, message: String , params : ExecBodyParams) {
         // more info https://docs.rs/twitch-irc/latest/twitch_irc/client/struct.TwitchIRCClient.html#method.say
 
         self.send_botmsg(BotMsgType::Say(channel_login.to_lowercase(), message), params).await;
     }
 
+
+
+
+
     async fn _me(&self, _: String, _: String) {
         // more info https://docs.rs/twitch-irc/latest/twitch_irc/client/struct.TwitchIRCClient.html#method.say
 

src/core/identity.rs

@@ -23,13 +23,10 @@ use std::env;
 
 fn adminvector() -> Vec<String> {
     vec![String::from("ModulatingForce")]
-    //vec![]
 }
 
 
 pub fn otherbots_vector() -> Vec<String> {
-    // vec![String::from("ModulatingForce")]
-    // //vec![]
 
     dotenv().ok();
     let mut other_bots = Vec::new();
@@ -1467,7 +1464,6 @@ impl IdentityManager {
                     return ChangeResult::NoChange("Already does not have VIP role".to_string());
                 } 
                 else {
-                    // self.affirm_chatter_in_db(trgchatter.clone()).await;
 
                     self.remove_role(trgchatter.clone(), UserRole::VIP(channel.clone())).await;
 

src/custom/experimental/experiment001.rs

@@ -15,6 +15,7 @@ const OF_CMD_CHANNEL:Channel = Channel(String::new());
 
 
 use rand::Rng;
+use twitch_irc::message::ReplyToMessage;
 use std::sync::Arc;
 
 use crate::core::bot_actions::ExecBodyParams;
@@ -95,8 +96,65 @@ pub async fn init(mgr: Arc<ModulesManager>) {
     // 2. Add the BotAction to ModulesManager
     botc1.add_to_modmgr(Arc::clone(&mgr)).await;
 
+    let bc1 = BotCommand {
+        module: BotModule(String::from("experiments001")),
+        command: String::from("rp1"), // command call name
+        alias: vec![
+            String::from("rp2"), 
+            String::from("rp3")], // String of alternative names
+        exec_body: actions_util::asyncbox(rp),
+        help: String::from("Test Command tester"),
+        required_roles: vec![
+            BotAdmin,
+            Mod(OF_CMD_CHANNEL),
+        ], 
+    };
+    bc1.add_core_to_modmgr(Arc::clone(&mgr)).await;
 }
 
+async fn rp(params : ExecBodyParams)
+{
+    //triggers if the message is a reply
+    if params.get_parent_reply().is_some(){
+
+        //getting the channel id where the message was sent
+        let channel_id = params.get_parent_reply().unwrap().channel_login;
+
+        //getting the first message id that was sent
+        let message_id = params.get_parent_reply().unwrap().message_id;
+
+        //just for testing purposes
+        //print!("{} , {}",channel_id, message_id); 
+
+        //creating a tuple with the channel id and message id
+        let answear =  
+        (
+            channel_id.clone(),
+            message_id.clone()
+        );
+
+        let bot = Arc::clone(&params.bot);
+        let botlock = bot.read().await;
+        // uses chat.say_in_reply_to() for the bot controls for messages
+        botlock
+        .botmgrs
+        .chat
+        .say_in_reply_to(
+            //using the tuple as param to the message being replied
+            Channel(answear.0),
+            answear.1,
+            String::from("hey there"),
+            params.clone()
+        ).await; 
+    }   
+    else    
+    {
+        println!("no reply")
+    }
+}
+
+
+
 async fn good_girl(params : ExecBodyParams) {
 
     // [ ] Uses gen_ratio() to output bool based on a ratio probability .
@@ -131,7 +189,8 @@ async fn good_girl(params : ExecBodyParams) {
             .botmgrs
             .chat
             .say_in_reply_to(
-                &params.msg, 
+                Channel(params.clone().msg.channel_login().to_string()),
+                params.clone().msg.message_id().to_string(), 
                 String::from("GoodGirl xdd "),
                 params.clone()
             ).await;
@@ -170,8 +229,8 @@ async fn babygirl(params : ExecBodyParams) {
     botlock
         .botmgrs
         .chat
-        .say_in_reply_to(
+        .say_in_reply(
-            &params.msg, 
+            Channel(params.clone().msg.channel_login().to_string()),
             String::from("16:13 notohh: cafdk"),
             params.clone()
         ).await;
@@ -182,8 +241,8 @@ async fn babygirl(params : ExecBodyParams) {
     botlock
     .botmgrs
     .chat
-    .say_in_reply_to(
+    .say_in_reply(
-        &params.msg, 
+        Channel(params.clone().msg.channel_login().to_string()),
         String::from("16:13 notohh: have fun eating princess"),
         params.clone()
     ).await;
@@ -194,8 +253,8 @@ async fn babygirl(params : ExecBodyParams) {
     botlock
     .botmgrs
     .chat
-    .say_in_reply_to(
+    .say_in_reply(
-        &params.msg, 
+        Channel(params.clone().msg.channel_login().to_string()),
         String::from("16:13 notohh: baby girl"),
         params.clone()
     ).await;

src/custom/experimental/experiment002.rs

@@ -17,6 +17,7 @@ const OF_CMD_CHANNEL:Channel = Channel(String::new());
 use std::sync::Arc;
 
 use chrono::{TimeZone,Local};
+use twitch_irc::message::ReplyToMessage;
 
 
 use crate::core::bot_actions::ExecBodyParams;
@@ -180,7 +181,8 @@ async fn sayout(params : ExecBodyParams) {
             .botmgrs
             .chat
             .say_in_reply_to(
-                &params.msg, 
+                Channel(params.clone().msg.channel_login().to_string()),
+                params.clone().msg.message_id().to_string(), 
                 String::from("Invalid arguments"),
                 params.clone()
             ).await;