path: root/src/primitive/message.rs

use std::{collections::HashMap, vec::Vec};

use failure::Error;

use crate::{deserialize::*, serialize::*};

use crate::primitive::BufferInfo;

use super::{Variant, VariantList};

/// The Message struct represents a Message as received in IRC
///
/// Messages are, like all other struct based types, serialized sequentially.
#[derive(Clone, Debug, std::cmp::PartialEq)]
pub struct Message {
    /// The unique, sequential id for the message
    /// i32 by default i64 if long-message-id features is enabled
    #[cfg(feature = "long-message-id")]
    #[cfg_attr(docsrs, doc(cfg(feature = "long-message-id")))]
    pub msg_id: i64,
    #[cfg(not(feature = "long-message-id"))]
    #[cfg_attr(docsrs, doc(cfg(not(feature = "long-message-id"))))]
    pub msg_id: i32,
    /// The timestamp of the message in UNIX time.
    /// If long-time is disabled this is an i32 representing the seconds since EPOCH.
    /// If long-time is enabled this is an i64 representing the miliseconds since EPOCH.
    #[cfg(feature = "long-time")]
    #[cfg_attr(docsrs, doc(cfg(feature = "long-time")))]
    pub timestamp: i64,
    #[cfg(not(feature = "long-time"))]
    #[cfg_attr(docsrs, doc(cfg(not(feature = "long-time"))))]
    pub timestamp: i32,
    /// The message type as it's own type serialized as i32
    pub msg_type: MessageType,
    /// The flags
    pub flags: i8,
    /// The buffer the message belongs to, usually everything but BufferId is set to NULL
    pub buffer: BufferInfo,
    /// The sender as nick!ident@host
    pub sender: String,
    /// The prefix modes of the sender.
    #[cfg(feature = "sender-prefixes")]
    #[cfg_attr(docsrs, doc(cfg(feature = "sender-prefixes")))]
    pub sender_prefixes: String,
    /// The realName of the sender
    #[cfg(feature = "rich-messages")]
    #[cfg_attr(docsrs, doc(cfg(feature = "rich-messages")))]
    pub real_name: String,
    /// The avatarUrl of the sender, if available
    #[cfg(feature = "rich-messages")]
    #[cfg_attr(docsrs, doc(cfg(feature = "rich-messages")))]
    pub avatar_url: String,
    /// The message content, already stripped from CTCP formatting, but containing mIRC format codes
    pub content: String,
}

impl Serialize for Message {
    fn serialize(&self) -> Result<Vec<u8>, Error> {
        let mut values: Vec<u8> = Vec::new();

        #[cfg(feature = "long-message-id")]
        values.append(&mut i64::serialize(&self.msg_id)?);
        #[cfg(not(feature = "long-message-id"))]
        values.append(&mut i32::serialize(&self.msg_id)?);

        #[cfg(feature = "long-time")]
        values.append(&mut i64::serialize(&self.timestamp)?);
        #[cfg(not(feature = "long-time"))]
        values.append(&mut i32::serialize(&(self.timestamp as i32))?);

        values.append(&mut i32::serialize(&(self.msg_type.bits()))?);
        values.append(&mut i8::serialize(&(self.flags as i8))?);
        values.append(&mut BufferInfo::serialize(&self.buffer)?);
        values.append(&mut String::serialize_utf8(&self.sender)?);

        #[cfg(feature = "sender-prefixes")]
        values.append(&mut String::serialize_utf8(&self.sender_prefixes)?);

        #[cfg(feature = "rich-messages")]
        {
            values.append(&mut String::serialize_utf8(&self.real_name)?);
            values.append(&mut String::serialize_utf8(&self.avatar_url)?);
        }

        values.append(&mut String::serialize_utf8(&self.content)?);

        return Ok(values);
    }
}

impl Deserialize for Message {
    fn parse(b: &[u8]) -> Result<(usize, Self), Error> {
        let mut pos = 0;
        #[cfg(feature = "long-message-id")]
        let (parsed, msg_id) = i64::parse(&b[pos..])?;
        #[cfg(not(feature = "long-message-id"))]
        let (parsed, msg_id) = i32::parse(&b[pos..])?;
        pos += parsed;

        // TODO LONGMESSAGES feature
        let timestamp;

        #[cfg(feature = "long-time")]
        {
            let (parsed, temp_timestamp) = i64::parse(&b[pos..])?;
            pos += parsed;
            timestamp = temp_timestamp;
        }

        #[cfg(not(feature = "long-time"))]
        {
            let (parsed, temp_timestamp) = i32::parse(&b[pos..])?;
            pos += parsed;
            timestamp = temp_timestamp;
        }

        let (parsed, msg_type) = i32::parse(&b[pos..])?;
        pos += parsed;
        let (parsed, flags) = i8::parse(&b[pos..])?;
        pos += parsed;
        let (parsed, buffer) = BufferInfo::parse(&b[pos..])?;
        pos += parsed;
        let (parsed, sender) = String::parse_utf8(&b[pos..])?;
        pos += parsed;

        #[cfg(feature = "sender-prefixes")]
        let sender_prefixes: String;
        #[cfg(feature = "sender-prefixes")]
        {
            let (parsed, temp) = String::parse_utf8(&b[pos..])?;
            sender_prefixes = temp;
            pos += parsed;
        }

        #[cfg(feature = "rich-messages")]
        let real_name: String;
        #[cfg(feature = "rich-messages")]
        let avatar_url: String;
        #[cfg(feature = "rich-messages")]
        {
            let (parsed, temp) = String::parse_utf8(&b[pos..])?;
            real_name = temp;
            pos += parsed;

            let (parsed, temp) = String::parse_utf8(&b[pos..])?;
            avatar_url = temp;
            pos += parsed;
        }

        let (parsed, content) = String::parse_utf8(&b[pos..])?;
        pos += parsed;

        return Ok((
            pos,
            Self {
                msg_id,
                timestamp,
                msg_type: MessageType::from_bits(msg_type).unwrap(),
                flags,
                buffer,
                sender,
                #[cfg(feature = "sender-prefixes")]
                sender_prefixes,
                #[cfg(feature = "rich-messages")]
                real_name,
                #[cfg(feature = "rich-messages")]
                avatar_url,
                content,
            },
        ));
    }
}

// #[repr(i32)]
// #[derive(Copy, Clone, Debug, std::cmp::PartialEq, FromPrimitive, ToPrimitive)]
// pub enum MessageType {
//     None = 0x00000000,
//     Plain = 0x00000001,
//     Notice = 0x00000002,
//     Action = 0x00000004,
//     Nick = 0x00000008,
//     Mode = 0x00000010,
//     Join = 0x00000020,
//     Part = 0x00000040,
//     Quit = 0x00000080,
//     Kick = 0x00000100,
//     Kill = 0x00000200,
//     Server = 0x00000400,
//     Info = 0x00000800,
//     Error = 0x00001000,
//     DayChange = 0x00002000,
//     Topic = 0x00004000,
//     NetsplitJoin = 0x00008000,
//     NetsplitQuit = 0x00010000,
//     Invite = 0x00020000,
//     Markerline = 0x00040000,
// }
use bitflags::bitflags;

bitflags! {
    pub struct MessageType: i32 {
        const NONE = 0x00000000;
        const PLAIN = 0x00000001;
        const NOTICE = 0x00000002;
        const ACTION = 0x00000004;
        const NICK = 0x00000008;
        const MODE = 0x00000010;
        const JOIN = 0x00000020;
        const PART = 0x00000040;
        const QUIT = 0x00000080;
        const KICK = 0x00000100;
        const KILL = 0x00000200;
        const SERVER = 0x00000400;
        const INFO = 0x00000800;
        const ERROR = 0x00001000;
        const DAY_CHANGE = 0x00002000;
        const TOPIC = 0x00004000;
        const NETSPLIT_JOIN = 0x00008000;
        const NETSPLIT_QUIT = 0x00010000;
        const INVITE = 0x00020000;
        const MARKERLINE = 0x00040000;
    }
}

impl<T> crate::message::NetworkList for HashMap<T, MessageType>
where
    T: std::convert::TryFrom<Variant> + Into<Variant> + Clone + std::hash::Hash + std::cmp::Eq,
{
    fn to_network_list(&self) -> VariantList {
        let mut res = Vec::with_capacity(self.len() * 2);

        self.iter().for_each(|(k, v)| {
            res.push((*k).clone().into());
            res.push((*v).clone().bits().into());
        });

        return res;
    }

    fn from_network_list(input: &mut VariantList) -> Self {
        use itertools::Itertools;

        let mut res = HashMap::with_capacity(input.len() / 2);

        input.iter().tuples().for_each(|(k, v)| {
            res.insert(
                match T::try_from(k.clone()) {
                    Ok(it) => it,
                    _ => unreachable!(),
                },
                {
                    let typ = v.try_into().expect("failed to get from variant");
                    MessageType::from_bits(typ).expect("failed to get messagetype from i32")
                },
            );
        });

        return res;
    }
}

#[cfg(test)]
#[cfg(feature = "all-quassel-features")]
mod tests {
    use super::*;
    use crate::primitive::{BufferInfo, BufferType};

    #[test]
    fn message_serialize() {
        let message = Message {
            msg_id: 1,
            timestamp: 1609846597,
            msg_type: MessageType::PLAIN,
            flags: 0,
            buffer: BufferInfo {
                id: 1,
                network_id: 1,
                buffer_type: BufferType::Channel,
                name: "#test".to_string(),
            },
            sender: "test".to_string(),
            content: "this is a test message".to_string(),
            sender_prefixes: "blabla".to_string(),
            real_name: "test user".to_string(),
            avatar_url: "https://jfkalsdkjfj.com/kjkj".to_string(),
        };

        assert_eq!(
            message.serialize().unwrap(),
            [
                0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 95, 244, 79, 69, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0,
                0, 0, 1, 0, 2, 0, 0, 0, 0, 0, 0, 0, 5, 35, 116, 101, 115, 116, 0, 0, 0, 4, 116,
                101, 115, 116, 0, 0, 0, 6, 98, 108, 97, 98, 108, 97, 0, 0, 0, 9, 116, 101, 115,
                116, 32, 117, 115, 101, 114, 0, 0, 0, 28, 104, 116, 116, 112, 115, 58, 47, 47, 106,
                102, 107, 97, 108, 115, 100, 107, 106, 102, 106, 46, 99, 111, 109, 47, 107, 106,
                107, 106, 0, 0, 0, 22, 116, 104, 105, 115, 32, 105, 115, 32, 97, 32, 116, 101, 115,
                116, 32, 109, 101, 115, 115, 97, 103, 101
            ]
        )
    }

    #[test]
    fn message_deserialize() {
        let message = Message {
            msg_id: 1,
            timestamp: 1609846597,
            msg_type: MessageType::PLAIN,
            flags: 0,
            buffer: BufferInfo {
                id: 1,
                network_id: 1,
                buffer_type: BufferType::Channel,
                name: "#test".to_string(),
            },
            sender: "test".to_string(),
            content: "this is a test message".to_string(),
            sender_prefixes: "blabla".to_string(),
            real_name: "test user".to_string(),
            avatar_url: "https://jfkalsdkjfj.com/kjkj".to_string(),
        };

        let bytes = vec![
            0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 95, 244, 79, 69, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0,
            0, 1, 0, 2, 0, 0, 0, 0, 0, 0, 0, 5, 35, 116, 101, 115, 116, 0, 0, 0, 4, 116, 101, 115,
            116, 0, 0, 0, 6, 98, 108, 97, 98, 108, 97, 0, 0, 0, 9, 116, 101, 115, 116, 32, 117,
            115, 101, 114, 0, 0, 0, 28, 104, 116, 116, 112, 115, 58, 47, 47, 106, 102, 107, 97,
            108, 115, 100, 107, 106, 102, 106, 46, 99, 111, 109, 47, 107, 106, 107, 106, 0, 0, 0,
            22, 116, 104, 105, 115, 32, 105, 115, 32, 97, 32, 116, 101, 115, 116, 32, 109, 101,
            115, 115, 97, 103, 101,
        ];

        assert_eq!(Message::parse(&bytes).unwrap(), (133, message))
    }
}