//! A single instance of a bot in a single room. //! //! See [`Instance`] for more details. use std::fmt; use std::str::FromStr; use std::sync::{Arc, Mutex}; use std::time::Duration; use cookie::{Cookie, CookieJar}; use log::{debug, warn}; use tokio::select; use tokio::sync::{mpsc, oneshot}; use tokio_tungstenite::tungstenite; use tokio_tungstenite::tungstenite::http::HeaderValue; use crate::api::packet::ParsedPacket; use crate::api::{Auth, AuthOption, Data, Nick}; use crate::conn::{self, Conn, ConnTx, State}; /// Settings that are usually shared between all instances connecting to a /// specific server. #[derive(Clone)] pub struct ServerConfig { /// How long to wait for the server until an operation is considered timed /// out. /// /// This timeout applies to waiting for reply packets to command packets /// sent by the client, as well as operations like connecting or closing a /// connection. pub timeout: Duration, /// How long to wait until reconnecting after an unsuccessful attempt to /// connect. pub reconnect_delay: Duration, /// Domain name, to be used with [`euphoxide::connect`]. pub domain: String, /// Cookies to use when connecting. They are updated with the server's reply /// after successful connection attempts. pub cookies: Arc>, } impl ServerConfig { pub fn timeout(mut self, timeout: Duration) -> Self { self.timeout = timeout; self } pub fn reconnect_delay(mut self, reconnect_delay: Duration) -> Self { self.reconnect_delay = reconnect_delay; self } pub fn domain(mut self, domain: S) -> Self { self.domain = domain.to_string(); self } pub fn cookies(mut self, cookies: Arc>) -> Self { self.cookies = cookies; self } pub fn room(self, room: S) -> InstanceConfig { InstanceConfig::new(self, room) } } impl Default for ServerConfig { fn default() -> Self { Self { timeout: Duration::from_secs(30), reconnect_delay: Duration::from_secs(30), domain: "euphoria.io".to_string(), cookies: Arc::new(Mutex::new(CookieJar::new())), } } } struct Hidden; impl fmt::Debug for Hidden { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "") } } impl fmt::Debug for ServerConfig { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.debug_struct("ServerConfig") .field("timeout", &self.timeout) .field("reconnect_delay", &self.reconnect_delay) .field("domain", &self.domain) .field("cookies", &Hidden) .finish() } } /// Settings that are usually specific to a single instance. #[derive(Debug, Clone)] pub struct InstanceConfig { pub server: ServerConfig, /// Unique name of this instance. pub name: String, /// Room name, to be used with [`euphoxide::connect`]. pub room: String, /// Whether the instance should connect as human or bot. pub human: bool, /// Username to set upon connecting. pub username: Option, /// Password to use if room requires authentication. pub password: Option, } impl InstanceConfig { pub fn new(server: ServerConfig, room: S) -> Self { Self { server, name: room.to_string(), room: room.to_string(), human: false, username: None, password: None, } } pub fn name(mut self, name: S) -> Self { self.name = name.to_string(); self } pub fn human(mut self, human: bool) -> Self { self.human = human; self } pub fn username(mut self, username: Option) -> Self { self.username = username.map(|s| s.to_string()); self } pub fn password(mut self, password: Option) -> Self { self.password = password.map(|s| s.to_string()); self } pub fn build(self, on_event: F) -> Instance where F: Fn(Event) + Send + Sync + 'static, { Instance::new(self, on_event) } } /// Snapshot of a [`Conn`]'s state immediately after receiving a packet. #[derive(Debug, Clone)] pub struct Snapshot { pub conn_tx: ConnTx, pub state: State, } // Most of the time, the largest variant (`Packet`) is sent. The size of this // enum is not critical anyways since it's not constructed that often. #[allow(clippy::large_enum_variant)] #[derive(Debug)] pub enum Event { Connecting(InstanceConfig), Connected(InstanceConfig, ConnTx), Packet(InstanceConfig, ParsedPacket, Snapshot), Disconnected(InstanceConfig), Stopped(InstanceConfig), } enum Request { GetConnTx(oneshot::Sender), Stop, } /// An error that occurred inside an [`Instance`] while it was running. enum RunError { StoppedManually, InstanceDropped, CouldNotConnect(tungstenite::Error), Conn(conn::Error), } /// A single instance of a bot in a single room. /// /// The instance automatically connects to its room once it is created, and it /// reconnects when it loses connection. If the room requires authentication and /// a password is given, the instance automatically authenticates. If a nick is /// given, the instance sets its nick upon joining the room. /// /// An instance has a unique name used for logging and identifying the instance. /// The room name can be used as the instance name if there is never more than /// one instance per room. #[derive(Debug)] pub struct Instance { config: InstanceConfig, request_tx: mpsc::UnboundedSender, } impl Instance { // Previously, the event callback was asynchronous and would return a result. It // was called in-line to calling Conn::recv. The idea was that the instance // would stop if the event handler returned Err. This was, however, not even // implemented correctly and the instance would just reconnect. // // The new event handler is synchronous. This way, it becomes harder to // accidentally block Conn::recv, for example by waiting for a channel with // limited capacity. If async code must be executed upon receiving a command, // the user can start a task from inside the handler. // // The new event handler does not return anything. This makes the code nicer. In // the use cases I'm thinking of, it should not be a problem: If the event // handler encounters errors, there's usually other ways to tell the same. Make // the event handler ignore the errors and stop the instance in that other way. pub fn new(config: InstanceConfig, on_event: F) -> Self where F: Fn(Event) + Send + Sync + 'static, { debug!("{}: Created with config {config:?}", config.name); let (request_tx, request_rx) = mpsc::unbounded_channel(); tokio::spawn(Self::run::(config.clone(), on_event, request_rx)); Self { config, request_tx } } pub fn config(&self) -> &InstanceConfig { &self.config } pub async fn conn_tx(&self) -> Option { let (tx, rx) = oneshot::channel(); let _ = self.request_tx.send(Request::GetConnTx(tx)); rx.await.ok() } pub fn stop(&self) { let _ = self.request_tx.send(Request::Stop); } async fn run( config: InstanceConfig, on_event: F, mut request_rx: mpsc::UnboundedReceiver, ) { loop { debug!("{}: Connecting...", config.name); on_event(Event::Connecting(config.clone())); let result = Self::run_once::(&config, &on_event, &mut request_rx).await; on_event(Event::Disconnected(config.clone())); let connected = match result { Ok(()) => { debug!("{}: Connection closed normally", config.name); true } Err(RunError::StoppedManually) => { debug!("{}: Instance stopped manually", config.name); break; } Err(RunError::InstanceDropped) => { debug!("{}: Instance dropped", config.name); break; } Err(RunError::CouldNotConnect(err)) => { warn!("{}: Failed to connect: {err}", config.name); false } Err(RunError::Conn(err)) => { warn!("{} An error occurred: {err}", config.name); true } }; if !connected { let s = config.server.reconnect_delay.as_secs(); debug!("{}: Waiting {s} seconds before reconnecting", config.name); tokio::time::sleep(config.server.reconnect_delay).await; } } on_event(Event::Stopped(config)) } fn get_cookies(config: &InstanceConfig) -> HeaderValue { let guard = config.server.cookies.lock().unwrap(); let cookies = guard .iter() .map(|c| format!("{}", c.stripped())) .collect::>() .join("; "); drop(guard); cookies.try_into().unwrap() } fn set_cookies(config: &InstanceConfig, cookies: Vec) { debug!("{}: Updating cookies", config.name); let mut guard = config.server.cookies.lock().unwrap(); for cookie in cookies { if let Ok(cookie) = cookie.to_str() { if let Ok(cookie) = Cookie::from_str(cookie) { guard.add(cookie); } } } } async fn run_once( config: &InstanceConfig, on_event: &F, request_rx: &mut mpsc::UnboundedReceiver, ) -> Result<(), RunError> { let (mut conn, cookies) = Conn::connect( &config.server.domain, &config.room, config.human, Some(Self::get_cookies(config)), config.server.timeout, ) .await .map_err(RunError::CouldNotConnect)?; Self::set_cookies(config, cookies); on_event(Event::Connected(config.clone(), conn.tx().clone())); let conn_tx = conn.tx().clone(); select! { r = Self::receive::(config, &mut conn, on_event) => r, r = Self::handle_requests(request_rx, &conn_tx) => Err(r), } } async fn receive( config: &InstanceConfig, conn: &mut Conn, on_event: &F, ) -> Result<(), RunError> { loop { let packet = conn.recv().await.map_err(RunError::Conn)?; let snapshot = Snapshot { conn_tx: conn.tx().clone(), state: conn.state().clone(), }; match &packet.content { Ok(Data::SnapshotEvent(_)) => { if let Some(username) = &config.username { debug!("{}: Setting nick to username {}", config.name, username); let name = username.to_string(); let _ = conn.tx().send(Nick { name }); } } Ok(Data::BounceEvent(_)) => { if let Some(password) = &config.password { debug!("{}: Authenticating with password", config.name); let cmd = Auth { r#type: AuthOption::Passcode, passcode: Some(password.to_string()), }; let _ = conn.tx().send(cmd); } else { warn!("{}: Auth required but no password configured", config.name); break; } } _ => {} } on_event(Event::Packet(config.clone(), packet, snapshot)); } Ok(()) } async fn handle_requests( request_rx: &mut mpsc::UnboundedReceiver, conn_tx: &ConnTx, ) -> RunError { while let Some(request) = request_rx.recv().await { match request { Request::GetConnTx(tx) => { let _ = tx.send(conn_tx.clone()); } Request::Stop => return RunError::StoppedManually, } } RunError::InstanceDropped } }