twitch_irc/message/commands/
clearmsg.rs

1use crate::message::commands::IRCMessageParseExt;
2use crate::message::{IRCMessage, ServerMessageParseError};
3use chrono::{DateTime, Utc};
4use std::convert::TryFrom;
5
6#[cfg(feature = "with-serde")]
7use {serde::Deserialize, serde::Serialize};
8
9/// Message for when a single message is deleted from chat.
10///
11/// The deleted message is identified by its `message_id`.
12#[derive(Debug, Clone, PartialEq, Eq)]
13#[cfg_attr(feature = "with-serde", derive(Serialize, Deserialize))]
14pub struct ClearMsgMessage {
15    /// Login name of the channel that the deleted message was posted in.
16    pub channel_login: String,
17    // pub channel_id: String,
18    /// login name of the user that sent the original message that was deleted by this
19    /// `CLEARMSG`.
20    pub sender_login: String,
21    /// ID of the message that was deleted.
22    pub message_id: String,
23    /// Text of the message that was deleted
24    pub message_text: String,
25    /// Whether the deleted message was an action (`/me`)
26    pub is_action: bool,
27    /// server timestamp for the time when the delete command was executed.
28    pub server_timestamp: DateTime<Utc>,
29
30    /// The message that this `ClearMsgMessage` was parsed from.
31    pub source: IRCMessage,
32}
33
34impl TryFrom<IRCMessage> for ClearMsgMessage {
35    type Error = ServerMessageParseError;
36
37    fn try_from(source: IRCMessage) -> Result<ClearMsgMessage, ServerMessageParseError> {
38        if source.command != "CLEARMSG" {
39            return Err(ServerMessageParseError::MismatchedCommand(Box::new(source)));
40        }
41
42        // example msg:
43        // @login=alazymeme;room-id=;target-msg-id=3c92014f-340a-4dc3-a9c9-e5cf182f4a84;tmi-sent-ts=1594561955611 :tmi.twitch.tv CLEARMSG #pajlada :NIGHT CUNT
44        // room-id is currently empty on all incoming messages, so we don't parse it
45        // see https://github.com/twitchdev/issues/issues/163
46        let (message_text, is_action) = source.try_get_message_text()?;
47
48        Ok(ClearMsgMessage {
49            channel_login: source.try_get_channel_login()?.to_owned(),
50            // channel_id: source.try_get_nonempty_tag_value("room-id")?.to_owned(),
51            sender_login: source.try_get_nonempty_tag_value("login")?.to_owned(),
52            message_id: source
53                .try_get_nonempty_tag_value("target-msg-id")?
54                .to_owned(),
55            server_timestamp: source.try_get_timestamp("tmi-sent-ts")?,
56            message_text: message_text.to_owned(),
57            is_action,
58            source,
59        })
60    }
61}
62
63impl From<ClearMsgMessage> for IRCMessage {
64    fn from(msg: ClearMsgMessage) -> IRCMessage {
65        msg.source
66    }
67}
68
69#[cfg(test)]
70mod tests {
71    use crate::message::{ClearMsgMessage, IRCMessage};
72    use chrono::{TimeZone, Utc};
73    use std::convert::TryFrom;
74
75    #[test]
76    pub fn test_simple() {
77        let src = "@login=alazymeme;room-id=;target-msg-id=3c92014f-340a-4dc3-a9c9-e5cf182f4a84;tmi-sent-ts=1594561955611 :tmi.twitch.tv CLEARMSG #pajlada :NIGHT CUNT";
78        let irc_message = IRCMessage::parse(src).unwrap();
79        let msg = ClearMsgMessage::try_from(irc_message.clone()).unwrap();
80
81        assert_eq!(
82            msg,
83            ClearMsgMessage {
84                channel_login: "pajlada".to_owned(),
85                sender_login: "alazymeme".to_owned(),
86                message_id: "3c92014f-340a-4dc3-a9c9-e5cf182f4a84".to_owned(),
87                message_text: "NIGHT CUNT".to_owned(),
88                is_action: false,
89                server_timestamp: Utc.timestamp_millis_opt(1_594_561_955_611).unwrap(),
90                source: irc_message
91            }
92        );
93    }
94
95    #[test]
96    pub fn test_action() {
97        let src = "@login=randers;room-id=;target-msg-id=15e5164d-f8e6-4aec-baf4-2d6a330760c4;tmi-sent-ts=1594562632383 :tmi.twitch.tv CLEARMSG #pajlada :\u{0001}ACTION test\u{0001}";
98        let irc_message = IRCMessage::parse(src).unwrap();
99        let msg = ClearMsgMessage::try_from(irc_message.clone()).unwrap();
100
101        assert_eq!(
102            msg,
103            ClearMsgMessage {
104                channel_login: "pajlada".to_owned(),
105                sender_login: "randers".to_owned(),
106                message_id: "15e5164d-f8e6-4aec-baf4-2d6a330760c4".to_owned(),
107                message_text: "test".to_owned(),
108                is_action: true,
109                server_timestamp: Utc.timestamp_millis_opt(1_594_562_632_383).unwrap(),
110                source: irc_message
111            }
112        );
113    }
114}
twitch_irc/message/commands/clearmsg.rs

twitch_irc/message/commands/
clearmsg.rs
