//! Implementations of chat-related features. pub mod handler; use std::sync::Arc; use azalea_chat::FormattedText; use azalea_protocol::packets::game::{ c_disguised_chat::ClientboundDisguisedChat, c_player_chat::ClientboundPlayerChat, c_system_chat::ClientboundSystemChat, }; use bevy_app::{App, Plugin, Update}; use bevy_ecs::prelude::*; use handler::{SendChatKindEvent, handle_send_chat_kind_event}; use uuid::Uuid; pub struct ChatPlugin; impl Plugin for ChatPlugin { fn build(&self, app: &mut App) { app.add_message::() .add_message::() .add_message::() .add_systems( Update, (handle_send_chat_event, handle_send_chat_kind_event).chain(), ); } } /// A chat packet, either a system message or a chat message. #[derive(Clone, Debug, PartialEq)] pub enum ChatPacket { System(Arc), Player(Arc), Disguised(Arc), } macro_rules! regex { ($re:literal $(,)?) => {{ static RE: std::sync::LazyLock = std::sync::LazyLock::new(|| regex::Regex::new($re).unwrap()); &RE }}; } impl ChatPacket { /// Get the message shown in chat for this packet. /// /// See [`Self::split_sender_and_content`] for more details about how this /// works. pub fn message(&self) -> FormattedText { match self { ChatPacket::System(p) => p.content.clone(), ChatPacket::Player(p) => p.message(), ChatPacket::Disguised(p) => p.message(), } } /// A convenience function to determine the username of the sender and /// the content of a chat message. /// /// This does not preserve formatting codes. /// /// This function uses a few checks to attempt to split the chat message, /// and is intended to work on most servers. It won't work for every server /// though, so in certain cases you may have to reimplement this yourself. /// /// If it's not a player-sent chat message or the sender couldn't be /// determined, the username part will be None. /// /// Also see [`Self::sender`] and [`Self::content`] if you only need one of /// the parts. pub fn split_sender_and_content(&self) -> (Option, String) { match self { ChatPacket::System(p) => { let message = p.content.to_string(); // overlay messages aren't in chat if p.overlay { return (None, message); } // it's a system message, so we'll have to match the content with regex // username surrounded by angle brackets (vanilla-like chat), and allow username // prefixes like [Owner] if let Some(m) = regex!(r"^<(?:\[[^\]]+?\] )?(\w{1,16})> (.+)$").captures(&message) { return (Some(m[1].to_string()), m[2].to_string()); } // username surrounded by square brackets (essentials whispers, vanilla-like // /say), and allow username prefixes if let Some(m) = regex!(r"^\[(?:\[[^\]]+?\] )?(\w{1,16})(?: -> me)?\] (.+)$").captures(&message) { return (Some(m[1].to_string()), m[2].to_string()); } // username without angle brackets (2b2t whispers, vanilla-like whispers) if let Some(m) = regex!(r"^(\w{1,16}) whispers(?: to you)?: (.+)$").captures(&message) { return (Some(m[1].to_string()), m[2].to_string()); } // hypixel whispers if let Some(m) = regex!(r"^From (?:\[[^\]]+\] )(\w{1,16}): (.+)$").captures(&message) { return (Some(m[1].to_string()), m[2].to_string()); } (None, message) } ChatPacket::Player(p) => ( // If it's a player chat packet, then the sender and content // are already split for us. Some(p.chat_type.name.to_string()), p.body.content.clone(), ), ChatPacket::Disguised(p) => ( // disguised chat packets are basically the same as player chat packets but without // the chat signing things Some(p.chat_type.name.to_string()), p.message.to_string(), ), } } /// Get the username of the sender of the message. /// /// If it's not a player-sent chat message or the sender couldn't be /// determined, this will be None. /// /// See [`Self::split_sender_and_content`] for more details about how this /// works. pub fn sender(&self) -> Option { self.split_sender_and_content().0 } /// Get the UUID of the sender of the message. /// /// If it's not a player-sent chat message, this will be None (this is /// sometimes the case when a server uses a plugin to modify chat /// messages). pub fn sender_uuid(&self) -> Option { match self { ChatPacket::System(_) => None, ChatPacket::Player(m) => Some(m.sender), ChatPacket::Disguised(_) => None, } } /// Get the content part of the message as a string. /// /// This does not preserve formatting codes. If it's not a player-sent chat /// message or the sender couldn't be determined, this will contain the /// entire message. pub fn content(&self) -> String { self.split_sender_and_content().1 } /// Create a new `ChatPacket` from a string. This is meant to be used as a /// convenience function for testing. pub fn new(message: &str) -> Self { ChatPacket::System(Arc::new(ClientboundSystemChat { content: FormattedText::from(message), overlay: false, })) } /// Whether this message is an incoming whisper message (i.e. someone else /// messaged the bot with /msg). /// /// This is not guaranteed to work correctly on custom servers. pub fn is_whisper(&self) -> bool { match self { ChatPacket::System(p) => { let message = p.content.to_string(); if p.overlay { return false; } if regex!(r"^(-> me|\w{1,16} whispers: )").is_match(&message) { return true; } // hypixel if regex!(r"^From (?:\[[^\]]+\] )?\w{1,16}: ").is_match(&message) { return true; } false } _ => match self.message() { FormattedText::Text(_) => false, FormattedText::Translatable(t) => t.key == "commands.message.display.incoming", }, } } } /// A client received a chat message packet. #[derive(Clone, Debug, Message)] pub struct ChatReceivedEvent { pub entity: Entity, pub packet: ChatPacket, } /// Send a chat message (or command, if it starts with a slash) to the server. #[derive(Message)] pub struct SendChatEvent { pub entity: Entity, pub content: String, } pub fn handle_send_chat_event( mut events: MessageReader, mut send_chat_kind_events: MessageWriter, ) { for event in events.read() { if event.content.starts_with('/') { send_chat_kind_events.write(SendChatKindEvent { entity: event.entity, content: event.content[1..].to_string(), kind: ChatKind::Command, }); } else { send_chat_kind_events.write(SendChatKindEvent { entity: event.entity, content: event.content.clone(), kind: ChatKind::Message, }); } } } /// A kind of chat packet, either a chat message or a command. pub enum ChatKind { Message, Command, } // TODO // MessageSigner, ChatMessageContent, LastSeenMessages // fn sign_message() -> MessageSignature { // MessageSignature::default() // }