telexide-fork 0.2.1

(working) Fork of Telexide: An async Rust library for the telegram bot API
Documentation
use chrono::{DateTime, Utc};
use serde::{Deserialize, Deserializer, Serialize, Serializer};

use super::{
    message_contents::*, message_entity::*, raw::*, Game, InlineKeyboardMarkup, Invoice,
    PassportData, Sticker, SuccessfulPayment, User,
};

/// This object represents a message.
#[derive(Debug, Clone, PartialEq)]
pub struct Message {
    /// Unique message identifier inside this chat
    pub message_id: i64,
    /// Sender, empty for messages sent to channels
    pub from: Option<super::User>,
    /// Sender of the message, sent on behalf of a chat. The channel itself for
    /// channel messages. The supergroup itself for messages from anonymous
    /// group administrators. The linked channel for messages automatically
    /// forwarded to the discussion group
    pub sender_chat: Option<super::Chat>,
    /// Date the message was sent
    pub date: DateTime<Utc>,
    /// Conversation the message belongs to
    pub chat: super::Chat,

    /// Data about what message it was forwarded from
    pub forward_data: Option<ForwardData>,

    pub reply_to_message: Option<Box<Message>>,
    /// Bot through which the message was sent
    pub via_bot: Option<User>,
    /// Date the message was last edited in Unix time
    pub edit_date: Option<DateTime<Utc>>,
    /// Signature of the post author for messages in channels
    pub author_signature: Option<String>,

    /// The content of the message
    pub content: MessageContent,

    /// The domain name of the website on which the user has logged in.
    pub connected_website: Option<String>,
    /// Telegram Passport data
    pub passport_data: Option<PassportData>,
    /// Inline keyboard attached to the message. `login_url` buttons are
    /// represented as ordinary `url` buttons.
    pub reply_markup: Option<InlineKeyboardMarkup>,
}

/// The content of a [`Message`]
#[allow(clippy::large_enum_variant)]
#[derive(Debug, Clone, PartialEq)]
pub enum MessageContent {
    Text {
        /// The actual UTF-8 text of the message, 0-4096 characters
        content: String,
        /// Special entities like usernames, URLs, bot commands, etc. that
        /// appear in the text
        entities: Vec<MessageEntity>,
    },
    Audio {
        /// Information about the audio file
        content: Audio,
        /// The caption, 0-1024 characters
        caption: Option<String>,
        /// Special entities like usernames, URLs, bot commands, etc. that
        /// appear in the caption
        caption_entities: Option<Vec<MessageEntity>>,
    },
    Document {
        /// Information about the file
        content: Document,
        /// The caption, 0-1024 characters
        caption: Option<String>,
        /// Special entities like usernames, URLs, bot commands, etc. that
        /// appear in the caption
        caption_entities: Option<Vec<MessageEntity>>,
    },
    Animation {
        /// Information about the animation.
        content: Animation,
        /// The caption, 0-1024 characters
        caption: Option<String>,
        /// Special entities like usernames, URLs, bot commands, etc. that
        /// appear in the caption
        caption_entities: Option<Vec<MessageEntity>>,
    },
    Video {
        /// Information about the video
        content: Video,
        /// The caption, 0-1024 characters
        caption: Option<String>,
        /// Special entities like usernames, URLs, bot commands, etc. that
        /// appear in the caption
        caption_entities: Option<Vec<MessageEntity>>,
        /// The unique identifier of a media message group this message belongs
        /// to
        media_group_id: Option<String>,
    },
    Voice {
        /// Information about the voice file
        content: Voice,
        /// The caption, 0-1024 characters
        caption: Option<String>,
        /// Special entities like usernames, URLs, bot commands, etc. that
        /// appear in the caption
        caption_entities: Option<Vec<MessageEntity>>,
    },
    Photo {
        /// Available sizes of the photo
        content: Vec<PhotoSize>,
        /// The caption, 0-1024 characters
        caption: Option<String>,
        /// Special entities like usernames, URLs, bot commands, etc. that
        /// appear in the caption
        caption_entities: Option<Vec<MessageEntity>>,
        /// The unique identifier of a media message group this message belongs
        /// to
        media_group_id: Option<String>,
    },

    Game {
        /// Information about the game
        content: Game,
    },
    Sticker {
        /// Information about the sticker
        content: Sticker,
    },
    VideoNote {
        /// Information about the video message
        content: VideoNote,
    },
    Contact {
        /// Information about the shared contact
        content: Contact,
    },
    Location {
        /// Information about the shared location
        content: Location,
    },
    Venue {
        /// Information about the venue
        content: Venue,
    },
    Poll {
        /// Information about the native poll
        content: Poll,
    },
    Dice {
        /// a dice with a random value from 1 to 6
        content: Dice,
    },
    NewChatMembers {
        /// New members that were added to the group or supergroup and
        /// information about them (the bot itself may be one of these
        /// members)
        content: Vec<User>,
    },
    LeftChatMember {
        /// A member was removed from the group, information about them
        /// (this member may be the bot itself)
        content: User,
    },
    NewChatTitle {
        /// A chat title was changed to this value
        content: String,
    },
    NewChatPhoto {
        /// A chat photo was change to this value
        content: Vec<PhotoSize>,
    },
    MessageAutoDeleteTimerChanged {
        /// Service message: auto-delete timer settings changed in the chat
        content: MessageAutoDeleteTimerChanged,
    },
    MigrateToChatID {
        /// The group has been migrated to a supergroup with the specified
        /// identifier.
        content: i64,
    },
    MigrateFromChatID {
        /// The supergroup has been migrated from a group with the specified
        /// identifier.
        content: i64,
    },
    PinnedMessage {
        /// Specified message was pinned. Note that the Message object in this
        /// field will not contain further reply_to_message fields even
        /// if it is itself a reply.
        content: Box<Message>,
    },
    Invoice {
        /// Message is an invoice for a [payment], information about the
        /// invoice.
        ///
        /// [payment]: https://core.telegram.org/bots/api#payments
        content: Invoice,
    },
    SuccessfulPayment {
        /// Message is a service message about a successful payment, information
        /// about the payment.
        content: SuccessfulPayment,
    },
    ProximityAlertTriggered {
        /// Service message. A user in the chat triggered another user's
        /// proximity alert while sharing Live Location.
        content: ProximityAlertTriggered,
    },
    VoiceChatScheduled {
        /// Service message: voice chat scheduled
        content: VoiceChatScheduled,
    },
    VoiceChatStarted {
        /// Service message: voice chat started
        content: VoiceChatStarted,
    },
    VoiceChatEnded {
        /// Service message: voice chat ended
        content: VoiceChatEnded,
    },
    VoiceChatParticipantsInvited {
        /// Service message: new participants invited to a voice chat
        content: VoiceChatParticipantsInvited,
    },

    /// Service message: the chat photo was deleted
    DeleteChatPhoto,
    /// Service message: the group has been created
    GroupChatCreated,
    /// Service message: the supergroup has been created.
    /// This field can‘t be received in a message coming through updates,
    /// because bot can’t be a member of a supergroup when it is created.
    /// It can only be found in reply_to_message if someone replies to a very
    /// first message in a directly created supergroup.
    SupergroupChatCreated,
    /// Service message: the channel has been created.
    /// This field can‘t be received in a message coming through updates,
    /// because bot can’t be a member of a channel when it is created.
    /// It can only be found in reply_to_message if someone replies to the very
    /// first message in a channel.
    ChannelChatCreated,
    /// Received a message with an unknown content
    Unknown,
}

/// Holds information about the forwarded message
#[derive(Debug, Clone, PartialEq)]
pub struct ForwardData {
    /// For forwarded messages, sender of the original message
    pub from: Option<super::User>,
    /// For messages forwarded from channels, information about the original
    /// channel
    pub from_chat: Option<super::Chat>,
    /// For messages forwarded from channels, identifier of the original message
    /// in the channel
    pub from_message_id: Option<i64>,
    /// For messages forwarded from channels, signature of the post author if
    /// present
    pub signature: Option<String>,
    /// Sender's name for messages forwarded from users who disallow adding a
    /// link to their account in forwarded messages
    pub sender_name: Option<String>,
    /// For forwarded messages, date the original message was sent in Unix time
    pub date: DateTime<Utc>,
}

impl Message {
    pub fn get_text(&self) -> Option<String> {
        match self.content {
            MessageContent::Text { ref content, .. } => Some(content.clone()),
            MessageContent::Audio { ref caption, .. }
            | MessageContent::Document { ref caption, .. }
            | MessageContent::Animation { ref caption, .. }
            | MessageContent::Video { ref caption, .. }
            | MessageContent::Voice { ref caption, .. }
            | MessageContent::Photo { ref caption, .. } => caption.clone(),
            _ => None,
        }
    }
}

impl From<RawMessage> for Message {
    #[allow(clippy::too_many_lines)]
    fn from(raw: RawMessage) -> Message {
        let message_id = raw.message_id;
        let from = raw.from;
        let sender_chat = raw.sender_chat.map(|c| c.into());
        let date = raw.date;
        let chat = raw.chat.into();
        let reply_to_message = raw.reply_to_message.map(|r| Box::new((*r).into()));
        let via_bot = raw.via_bot;
        let edit_date = raw.edit_date;
        let author_signature = raw.author_signature;
        let connected_website = raw.connected_website;
        let passport_data = raw.passport_data;
        let reply_markup = raw.reply_markup;

        let forward_data = if let Some(d) = raw.forward_date {
            Some(ForwardData {
                from: raw.forward_from,
                from_chat: raw.forward_from_chat.map(|c| c.into()),
                from_message_id: raw.forward_from_message_id,
                signature: raw.forward_signature,
                sender_name: raw.forward_sender_name,
                date: d,
            })
        } else {
            None
        };

        let fill_in_content = |content: MessageContent| Self {
            message_id,
            from,
            sender_chat,
            date,
            chat,
            forward_data,
            reply_to_message,
            via_bot,
            edit_date,
            author_signature,
            content,
            connected_website,
            passport_data,
            reply_markup,
        };

        if let Some(c) = raw.text {
            return fill_in_content(MessageContent::Text {
                content: c,
                entities: raw.entities.unwrap_or_default(),
            });
        } else if let Some(c) = raw.video {
            return fill_in_content(MessageContent::Video {
                content: c,
                caption: raw.caption,
                caption_entities: raw.caption_entities,
                media_group_id: raw.media_group_id,
            });
        } else if let Some(c) = raw.photo {
            return fill_in_content(MessageContent::Photo {
                content: c,
                caption: raw.caption,
                caption_entities: raw.caption_entities,
                media_group_id: raw.media_group_id,
            });
        } else if let Some(c) = raw.pinned_message {
            return fill_in_content(MessageContent::PinnedMessage {
                content: Box::new((*c).into()),
            });
        }

        macro_rules! content_with_captions {
            ($data:expr, $kind:ident) => {
                if let Some(c) = $data {
                    return fill_in_content(MessageContent::$kind {
                        content: c,
                        caption: raw.caption,
                        caption_entities: raw.caption_entities,
                    });
                }
            };
        }

        macro_rules! content {
            ($data:expr, $kind:ident) => {
                if let Some(c) = $data {
                    return fill_in_content(MessageContent::$kind { content: c });
                }
            };
        }

        macro_rules! bool_content {
            ($data:expr, $kind:ident) => {
                if $data {
                    return fill_in_content(MessageContent::$kind);
                }
            };
        }

        content_with_captions!(raw.audio, Audio);
        content_with_captions!(raw.animation, Animation);
        content_with_captions!(raw.document, Document);
        content_with_captions!(raw.voice, Voice);

        content!(raw.game, Game);
        content!(raw.sticker, Sticker);
        content!(raw.video_note, VideoNote);
        content!(raw.contact, Contact);
        content!(raw.location, Location);
        content!(raw.venue, Venue);
        content!(raw.poll, Poll);
        content!(raw.dice, Dice);
        content!(raw.new_chat_members, NewChatMembers);
        content!(raw.left_chat_member, LeftChatMember);
        content!(raw.new_chat_title, NewChatTitle);
        content!(raw.new_chat_photo, NewChatPhoto);
        content!(
            raw.message_auto_delete_timer_changed,
            MessageAutoDeleteTimerChanged
        );
        content!(raw.migrate_to_chat_id, MigrateToChatID);
        content!(raw.migrate_from_chat_id, MigrateFromChatID);
        content!(raw.invoice, Invoice);
        content!(raw.successful_payment, SuccessfulPayment);
        content!(raw.proximity_alert_triggered, ProximityAlertTriggered);
        content!(raw.voice_chat_scheduled, VoiceChatScheduled);
        content!(raw.voice_chat_started, VoiceChatStarted);
        content!(raw.voice_chat_ended, VoiceChatEnded);
        content!(
            raw.voice_chat_participants_invited,
            VoiceChatParticipantsInvited
        );

        bool_content!(raw.delete_chat_photo, DeleteChatPhoto);
        bool_content!(raw.group_chat_created, GroupChatCreated);
        bool_content!(raw.supergroup_chat_created, SupergroupChatCreated);
        bool_content!(raw.channel_chat_created, ChannelChatCreated);

        fill_in_content(MessageContent::Unknown)
    }
}

impl From<Message> for RawMessage {
    #[allow(clippy::too_many_lines)]
    fn from(message: Message) -> RawMessage {
        let mut ret = Self {
            message_id: message.message_id,
            from: message.from,
            sender_chat: message.sender_chat.map(|c| c.into()),
            date: message.date,
            chat: message.chat.into(),
            reply_to_message: message.reply_to_message.map(|r| Box::new((*r).into())),
            via_bot: message.via_bot,
            edit_date: message.edit_date,
            media_group_id: None,
            author_signature: message.author_signature,

            forward_date: None,
            forward_sender_name: None,
            forward_signature: None,
            forward_from_message_id: None,
            forward_from: None,
            forward_from_chat: None,

            text: None,
            entities: None,
            caption_entities: None,
            audio: None,
            document: None,
            animation: None,
            game: None,
            photo: None,
            sticker: None,
            video: None,
            voice: None,
            video_note: None,
            caption: None,
            contact: None,
            location: None,
            venue: None,
            poll: None,
            dice: None,
            new_chat_members: None,
            left_chat_member: None,
            new_chat_title: None,
            new_chat_photo: None,
            delete_chat_photo: false,
            group_chat_created: false,
            supergroup_chat_created: false,
            channel_chat_created: false,
            message_auto_delete_timer_changed: None,
            migrate_to_chat_id: None,
            migrate_from_chat_id: None,
            pinned_message: None,
            invoice: None,
            successful_payment: None,
            proximity_alert_triggered: None,
            voice_chat_scheduled: None,
            voice_chat_started: None,
            voice_chat_ended: None,
            voice_chat_participants_invited: None,

            connected_website: message.connected_website,
            passport_data: message.passport_data,
            reply_markup: message.reply_markup,
        };

        if let Some(d) = message.forward_data {
            ret.forward_date = Some(d.date);
            ret.forward_sender_name = d.sender_name;
            ret.forward_signature = d.signature;
            ret.forward_from_message_id = d.from_message_id;
            ret.forward_from = d.from;
            ret.forward_from_chat = d.from_chat.map(|c| c.into());
        }

        match message.content {
            MessageContent::Text { content, entities } => {
                ret.text = Some(content);
                ret.entities = Some(entities);
                ret
            }
            MessageContent::Audio {
                content,
                caption,
                caption_entities,
            } => {
                ret.audio = Some(content);
                ret.caption = caption;
                ret.caption_entities = caption_entities;
                ret
            }
            MessageContent::Document {
                content,
                caption,
                caption_entities,
            } => {
                ret.document = Some(content);
                ret.caption = caption;
                ret.caption_entities = caption_entities;
                ret
            }
            MessageContent::Animation {
                content,
                caption,
                caption_entities,
            } => {
                ret.animation = Some(content);
                ret.caption = caption;
                ret.caption_entities = caption_entities;
                ret
            }
            MessageContent::Voice {
                content,
                caption,
                caption_entities,
            } => {
                ret.voice = Some(content);
                ret.caption = caption;
                ret.caption_entities = caption_entities;
                ret
            }
            MessageContent::Video {
                content,
                caption,
                caption_entities,
                media_group_id,
            } => {
                ret.video = Some(content);
                ret.caption = caption;
                ret.caption_entities = caption_entities;
                ret.media_group_id = media_group_id;
                ret
            }
            MessageContent::Photo {
                content,
                caption,
                caption_entities,
                media_group_id,
            } => {
                ret.photo = Some(content);
                ret.caption = caption;
                ret.caption_entities = caption_entities;
                ret.media_group_id = media_group_id;
                ret
            }
            MessageContent::Game { content } => {
                ret.game = Some(content);
                ret
            }
            MessageContent::Sticker { content } => {
                ret.sticker = Some(content);
                ret
            }
            MessageContent::VideoNote { content } => {
                ret.video_note = Some(content);
                ret
            }
            MessageContent::Contact { content } => {
                ret.contact = Some(content);
                ret
            }
            MessageContent::Location { content } => {
                ret.location = Some(content);
                ret
            }
            MessageContent::Venue { content } => {
                ret.venue = Some(content);
                ret
            }
            MessageContent::Poll { content } => {
                ret.poll = Some(content);
                ret
            }
            MessageContent::Dice { content } => {
                ret.dice = Some(content);
                ret
            }
            MessageContent::NewChatMembers { content } => {
                ret.new_chat_members = Some(content);
                ret
            }
            MessageContent::LeftChatMember { content } => {
                ret.left_chat_member = Some(content);
                ret
            }
            MessageContent::NewChatTitle { content } => {
                ret.new_chat_title = Some(content);
                ret
            }
            MessageContent::NewChatPhoto { content } => {
                ret.new_chat_photo = Some(content);
                ret
            }
            MessageContent::MessageAutoDeleteTimerChanged { content } => {
                ret.message_auto_delete_timer_changed = Some(content);
                ret
            }
            MessageContent::MigrateToChatID { content } => {
                ret.migrate_to_chat_id = Some(content);
                ret
            }
            MessageContent::MigrateFromChatID { content } => {
                ret.migrate_from_chat_id = Some(content);
                ret
            }
            MessageContent::Invoice { content } => {
                ret.invoice = Some(content);
                ret
            }
            MessageContent::SuccessfulPayment { content } => {
                ret.successful_payment = Some(content);
                ret
            }
            MessageContent::PinnedMessage { content } => {
                ret.pinned_message = Some(Box::new((*content).into()));
                ret
            }
            MessageContent::ProximityAlertTriggered { content } => {
                ret.proximity_alert_triggered = Some(content);
                ret
            }
            MessageContent::VoiceChatScheduled { content } => {
                ret.voice_chat_scheduled = Some(content);
                ret
            }
            MessageContent::VoiceChatStarted { content } => {
                ret.voice_chat_started = Some(content);
                ret
            }
            MessageContent::VoiceChatEnded { content } => {
                ret.voice_chat_ended = Some(content);
                ret
            }
            MessageContent::VoiceChatParticipantsInvited { content } => {
                ret.voice_chat_participants_invited = Some(content);
                ret
            }
            MessageContent::DeleteChatPhoto => {
                ret.delete_chat_photo = true;
                ret
            }
            MessageContent::GroupChatCreated => {
                ret.group_chat_created = true;
                ret
            }
            MessageContent::SupergroupChatCreated => {
                ret.supergroup_chat_created = true;
                ret
            }
            MessageContent::ChannelChatCreated => {
                ret.channel_chat_created = true;
                ret
            }
            MessageContent::Unknown => ret,
        }
    }
}

impl<'de> Deserialize<'de> for Message {
    fn deserialize<D>(deserializer: D) -> Result<Message, D::Error>
    where
        D: Deserializer<'de>,
    {
        let raw: RawMessage = Deserialize::deserialize(deserializer)?;

        Ok(raw.into())
    }
}

impl Serialize for Message {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        RawMessage::from(self.clone()).serialize(serializer)
    }
}

/// This object represents a unique message identifier.
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct MessageId {
    /// Unique message identifier
    pub message_id: i64,
}