diff --git a/CHANGELOG.md b/CHANGELOG.md index 1464ea7..524e877 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,46 @@ Procedure when bumping the version number: ## Unreleased +## v0.6.1 - 2025-02-23 + +### Changed + +- Updated set of emoji names + +### Fixed + +- Nick hue hashing algorithm in some edge cases + +## v0.6.0 - 2025-02-21 + +### Added + +- `api::Time::from_timestamp` +- `api::Time::as_timestamp` +- `bot::botrulez::full_help` +- `bot::botrulez::ping` +- `bot::botrulez::short_help` +- `bot::botrulez::uptime` +- `bot::botrulez::format_relative_time` + +### Changed + +- **(breaking)** Switched to `jiff` from `time` +- **(breaking)** `api::Time` contents are now an `i64` +- **(breaking)** Bumped `tokio-tungstenite` dependency from `0.18` to `0.24`. If + this causes a panic while using euphoxide, consider following the steps + mentioned in the [tokio-tungstenite README]. If I'm reading the [rustls docs] + correctly, it is on the users of the libraries to set the required features. +- `bot::botrulez::format_duration` now no longer mentions "since" or "ago", but + instead has a sign (`-`) if the duration is negative. + +[tokio-tungstenite README]: https://github.com/snapview/tokio-tungstenite?tab=readme-ov-file#features +[rustls docs]: https://docs.rs/rustls/0.23.19/rustls/crypto/struct.CryptoProvider.html#using-the-per-process-default-cryptoprovider + +### Removed + +- `api::Time::new` + ## v0.5.1 - 2024-05-20 ### Added diff --git a/Cargo.toml b/Cargo.toml index fb59b0d..cf65579 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,33 +1,34 @@ [package] name = "euphoxide" -version = "0.5.1" +version = "0.6.1" edition = "2021" [features] bot = ["dep:async-trait", "dep:clap", "dep:cookie"] [dependencies] -async-trait = { version = "0.1.80", optional = true } -caseless = "0.2.1" +async-trait = { version = "0.1.86", optional = true } +caseless = "0.2.2" cookie = { version = "0.18.1", optional = true } -futures-util = { version = "0.3.30", default-features = false, features = ["sink"] } -log = "0.4.21" -serde = { version = "1.0.202", features = ["derive"] } -serde_json = "1.0.117" -time = { version = "0.3.36", features = ["serde"] } -tokio = { version = "1.37.0", features = ["time", "sync", "macros", "rt"] } -tokio-stream = "0.1.15" -tokio-tungstenite = { version = "0.21.0", features = ["rustls-tls-native-roots"] } -unicode-normalization = "0.1.23" +futures-util = { version = "0.3.31", default-features = false, features = ["sink"] } +jiff = { version = "0.2.1", features = ["serde"] } +log = "0.4.25" +serde = { version = "1.0.218", features = ["derive"] } +serde_json = "1.0.139" +tokio = { version = "1.43.0", features = ["time", "sync", "macros", "rt"] } +tokio-stream = "0.1.17" +tokio-tungstenite = { version = "0.26.2", features = ["rustls-tls-native-roots"] } +unicode-normalization = "0.1.24" [dependencies.clap] -version = "4.5.4" +version = "4.5.30" optional = true default-features = false features = ["std", "derive", "deprecated"] [dev-dependencies] # For example bot -tokio = { version = "1.37.0", features = ["rt-multi-thread"] } +rustls = "0.23.23" +tokio = { version = "1.43.0", features = ["rt-multi-thread"] } [[example]] name = "testbot_instance" @@ -40,3 +41,24 @@ required-features = ["bot"] [[example]] name = "testbot_commands" required-features = ["bot"] + +[lints] +rust.unsafe_code = { level = "forbid", priority = 1 } +# Lint groups +rust.deprecated_safe = "warn" +rust.future_incompatible = "warn" +rust.keyword_idents = "warn" +rust.rust_2018_idioms = "warn" +rust.unused = "warn" +# Individual lints +rust.non_local_definitions = "warn" +rust.redundant_imports = "warn" +rust.redundant_lifetimes = "warn" +rust.single_use_lifetimes = "warn" +rust.unit_bindings = "warn" +rust.unnameable_types = "warn" +rust.unused_import_braces = "warn" +rust.unused_lifetimes = "warn" +rust.unused_qualifications = "warn" +# Clippy +clippy.use_self = "warn" diff --git a/examples/testbot_commands.rs b/examples/testbot_commands.rs index 3a07c19..c3afada 100644 --- a/examples/testbot_commands.rs +++ b/examples/testbot_commands.rs @@ -12,8 +12,8 @@ use euphoxide::bot::commands::Commands; use euphoxide::bot::instance::{Event, ServerConfig}; use euphoxide::bot::instances::Instances; use euphoxide::conn; +use jiff::Timestamp; use log::error; -use time::OffsetDateTime; use tokio::sync::mpsc; const HELP: &str = "I'm an example bot for https://github.com/Garmelon/euphoxide"; @@ -74,7 +74,7 @@ impl ClapCommand for Test { struct Bot { commands: Arc>, - start_time: OffsetDateTime, + start_time: Timestamp, stop: bool, } @@ -85,13 +85,18 @@ impl HasDescriptions for Bot { } impl HasStartTime for Bot { - fn start_time(&self) -> OffsetDateTime { + fn start_time(&self) -> Timestamp { self.start_time } } #[tokio::main] async fn main() { + // https://github.com/snapview/tokio-tungstenite/issues/353#issuecomment-2455247837 + rustls::crypto::aws_lc_rs::default_provider() + .install_default() + .unwrap(); + let (tx, mut rx) = mpsc::unbounded_channel(); let mut instances = Instances::new(ServerConfig::default()); @@ -107,7 +112,7 @@ async fn main() { let mut bot = Bot { commands: cmds.clone(), - start_time: OffsetDateTime::now_utc(), + start_time: Timestamp::now(), stop: false, }; diff --git a/examples/testbot_instance.rs b/examples/testbot_instance.rs index 5b932b3..f60f3b9 100644 --- a/examples/testbot_instance.rs +++ b/examples/testbot_instance.rs @@ -3,46 +3,14 @@ use euphoxide::api::packet::ParsedPacket; use euphoxide::api::{Data, Nick, Send}; +use euphoxide::bot::botrulez; use euphoxide::bot::instance::{ConnSnapshot, Event, ServerConfig}; -use time::OffsetDateTime; +use jiff::Timestamp; use tokio::sync::mpsc; const NICK: &str = "TestBot"; const HELP: &str = "I'm an example bot for https://github.com/Garmelon/euphoxide"; -fn format_delta(delta: time::Duration) -> String { - const MINUTE: u64 = 60; - const HOUR: u64 = MINUTE * 60; - const DAY: u64 = HOUR * 24; - - let mut seconds: u64 = delta.whole_seconds().try_into().unwrap(); - let mut parts = vec![]; - - let days = seconds / DAY; - if days > 0 { - parts.push(format!("{days}d")); - seconds -= days * DAY; - } - - let hours = seconds / HOUR; - if hours > 0 { - parts.push(format!("{hours}h")); - seconds -= hours * HOUR; - } - - let mins = seconds / MINUTE; - if mins > 0 { - parts.push(format!("{mins}m")); - seconds -= mins * MINUTE; - } - - if parts.is_empty() || seconds > 0 { - parts.push(format!("{seconds}s")); - } - - parts.join(" ") -} - async fn on_packet(packet: ParsedPacket, snapshot: ConnSnapshot) -> Result<(), ()> { let data = match packet.content { Ok(data) => data, @@ -107,8 +75,11 @@ async fn on_packet(packet: ParsedPacket, snapshot: ConnSnapshot) -> Result<(), ( reply = Some(HELP.to_string()); } else if content == format!("!uptime @{NICK}") { if let Some(joined) = snapshot.state.joined() { - let delta = OffsetDateTime::now_utc() - joined.since; - reply = Some(format!("/me has been up for {}", format_delta(delta))); + let delta = Timestamp::now() - joined.since; + reply = Some(format!( + "/me has been up for {}", + botrulez::format_duration(delta) + )); } } else if content == "!test" { reply = Some("Test successful!".to_string()); @@ -151,6 +122,11 @@ async fn on_packet(packet: ParsedPacket, snapshot: ConnSnapshot) -> Result<(), ( #[tokio::main] async fn main() { + // https://github.com/snapview/tokio-tungstenite/issues/353#issuecomment-2455247837 + rustls::crypto::aws_lc_rs::default_provider() + .install_default() + .unwrap(); + let (tx, mut rx) = mpsc::unbounded_channel(); let _instance = ServerConfig::default() diff --git a/examples/testbot_instances.rs b/examples/testbot_instances.rs index a8a6848..0fb612f 100644 --- a/examples/testbot_instances.rs +++ b/examples/testbot_instances.rs @@ -3,47 +3,15 @@ use euphoxide::api::packet::ParsedPacket; use euphoxide::api::{Data, Nick, Send}; +use euphoxide::bot::botrulez; use euphoxide::bot::instance::{ConnSnapshot, Event, ServerConfig}; use euphoxide::bot::instances::Instances; -use time::OffsetDateTime; +use jiff::Timestamp; use tokio::sync::mpsc; const NICK: &str = "TestBot"; const HELP: &str = "I'm an example bot for https://github.com/Garmelon/euphoxide"; -fn format_delta(delta: time::Duration) -> String { - const MINUTE: u64 = 60; - const HOUR: u64 = MINUTE * 60; - const DAY: u64 = HOUR * 24; - - let mut seconds: u64 = delta.whole_seconds().try_into().unwrap(); - let mut parts = vec![]; - - let days = seconds / DAY; - if days > 0 { - parts.push(format!("{days}d")); - seconds -= days * DAY; - } - - let hours = seconds / HOUR; - if hours > 0 { - parts.push(format!("{hours}h")); - seconds -= hours * HOUR; - } - - let mins = seconds / MINUTE; - if mins > 0 { - parts.push(format!("{mins}m")); - seconds -= mins * MINUTE; - } - - if parts.is_empty() || seconds > 0 { - parts.push(format!("{seconds}s")); - } - - parts.join(" ") -} - async fn on_packet(packet: ParsedPacket, snapshot: ConnSnapshot) -> Result<(), ()> { let data = match packet.content { Ok(data) => data, @@ -108,8 +76,11 @@ async fn on_packet(packet: ParsedPacket, snapshot: ConnSnapshot) -> Result<(), ( reply = Some(HELP.to_string()); } else if content == format!("!uptime @{NICK}") { if let Some(joined) = snapshot.state.joined() { - let delta = OffsetDateTime::now_utc() - joined.since; - reply = Some(format!("/me has been up for {}", format_delta(delta))); + let delta = Timestamp::now() - joined.since; + reply = Some(format!( + "/me has been up for {}", + botrulez::format_duration(delta) + )); } } else if content == "!test" { reply = Some("Test successful!".to_string()); @@ -152,6 +123,11 @@ async fn on_packet(packet: ParsedPacket, snapshot: ConnSnapshot) -> Result<(), ( #[tokio::main] async fn main() { + // https://github.com/snapview/tokio-tungstenite/issues/353#issuecomment-2455247837 + rustls::crypto::aws_lc_rs::default_provider() + .install_default() + .unwrap(); + let (tx, mut rx) = mpsc::unbounded_channel(); let mut instances = Instances::new(ServerConfig::default()); diff --git a/examples/testbot_manual.rs b/examples/testbot_manual.rs index c059004..da21db0 100644 --- a/examples/testbot_manual.rs +++ b/examples/testbot_manual.rs @@ -6,8 +6,9 @@ use std::time::Duration; use euphoxide::api::packet::ParsedPacket; use euphoxide::api::{Data, Nick, Send}; +use euphoxide::bot::botrulez; use euphoxide::conn::{Conn, ConnTx, State}; -use time::OffsetDateTime; +use jiff::Timestamp; const TIMEOUT: Duration = Duration::from_secs(10); const DOMAIN: &str = "euphoria.leet.nu"; @@ -15,39 +16,6 @@ const ROOM: &str = "test"; const NICK: &str = "TestBot"; const HELP: &str = "I'm an example bot for https://github.com/Garmelon/euphoxide"; -fn format_delta(delta: time::Duration) -> String { - const MINUTE: u64 = 60; - const HOUR: u64 = MINUTE * 60; - const DAY: u64 = HOUR * 24; - - let mut seconds: u64 = delta.whole_seconds().try_into().unwrap(); - let mut parts = vec![]; - - let days = seconds / DAY; - if days > 0 { - parts.push(format!("{days}d")); - seconds -= days * DAY; - } - - let hours = seconds / HOUR; - if hours > 0 { - parts.push(format!("{hours}h")); - seconds -= hours * HOUR; - } - - let mins = seconds / MINUTE; - if mins > 0 { - parts.push(format!("{mins}m")); - seconds -= mins * MINUTE; - } - - if parts.is_empty() || seconds > 0 { - parts.push(format!("{seconds}s")); - } - - parts.join(" ") -} - async fn on_packet(packet: ParsedPacket, conn_tx: &ConnTx, state: &State) -> Result<(), ()> { let data = match packet.content { Ok(data) => data, @@ -112,8 +80,11 @@ async fn on_packet(packet: ParsedPacket, conn_tx: &ConnTx, state: &State) -> Res reply = Some(HELP.to_string()); } else if content == format!("!uptime @{NICK}") { if let Some(joined) = state.joined() { - let delta = OffsetDateTime::now_utc() - joined.since; - reply = Some(format!("/me has been up for {}", format_delta(delta))); + let delta = Timestamp::now() - joined.since; + reply = Some(format!( + "/me has been up for {}", + botrulez::format_duration(delta) + )); } } else if content == "!test" { reply = Some("Test successful!".to_string()); @@ -155,6 +126,11 @@ async fn on_packet(packet: ParsedPacket, conn_tx: &ConnTx, state: &State) -> Res #[tokio::main] async fn main() -> Result<(), Box> { + // https://github.com/snapview/tokio-tungstenite/issues/353#issuecomment-2455247837 + rustls::crypto::aws_lc_rs::default_provider() + .install_default() + .unwrap(); + let (mut conn, _) = Conn::connect(DOMAIN, ROOM, false, None, TIMEOUT).await?; while let Ok(packet) = conn.recv().await { diff --git a/src/api.rs b/src/api.rs index d72b91c..e24ca1d 100644 --- a/src/api.rs +++ b/src/api.rs @@ -1,6 +1,6 @@ //! Models the [euphoria API][0]. //! -//! [0](https://github.com/CylonicRaider/heim/blob/master/doc/api.md) +//! [0]: https://euphoria.leet.nu/heim/api mod account_cmds; mod events; diff --git a/src/api/types.rs b/src/api/types.rs index d1a393d..b1408a8 100644 --- a/src/api/types.rs +++ b/src/api/types.rs @@ -10,9 +10,9 @@ use std::num::ParseIntError; use std::str::FromStr; use std::{error, fmt}; +use jiff::Timestamp; use serde::{de, ser, Deserialize, Serialize}; use serde_json::Value; -use time::{OffsetDateTime, UtcOffset}; /// Describes an account and its preferred name. #[derive(Debug, Clone, Serialize, Deserialize)] @@ -403,19 +403,19 @@ impl<'de> Deserialize<'de> for Snowflake { /// Time is specified as a signed 64-bit integer, giving the number of seconds /// since the Unix Epoch. #[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] -pub struct Time(#[serde(with = "time::serde::timestamp")] pub OffsetDateTime); +pub struct Time(pub i64); impl Time { - pub fn new(time: OffsetDateTime) -> Self { - let time = time - .to_offset(UtcOffset::UTC) - .replace_millisecond(0) - .unwrap(); - Self(time) + pub fn from_timestamp(time: Timestamp) -> Self { + Self(time.as_second()) + } + + pub fn as_timestamp(&self) -> Timestamp { + Timestamp::from_second(self.0).unwrap() } pub fn now() -> Self { - Self::new(OffsetDateTime::now_utc()) + Self::from_timestamp(Timestamp::now()) } } diff --git a/src/bot/botrulez.rs b/src/bot/botrulez.rs index 3161ad6..6dd5adb 100644 --- a/src/bot/botrulez.rs +++ b/src/bot/botrulez.rs @@ -1,10 +1,10 @@ //! The main [botrulez](https://github.com/jedevc/botrulez) commands. -mod full_help; -mod ping; -mod short_help; -mod uptime; +pub mod full_help; +pub mod ping; +pub mod short_help; +pub mod uptime; pub use self::full_help::{FullHelp, HasDescriptions}; pub use self::ping::Ping; pub use self::short_help::ShortHelp; -pub use self::uptime::{format_duration, format_time, HasStartTime, Uptime}; +pub use self::uptime::{format_duration, format_relative_time, format_time, HasStartTime, Uptime}; diff --git a/src/bot/botrulez/uptime.rs b/src/bot/botrulez/uptime.rs index b4465e5..d8b1d0d 100644 --- a/src/bot/botrulez/uptime.rs +++ b/src/bot/botrulez/uptime.rs @@ -1,24 +1,29 @@ use async_trait::async_trait; use clap::Parser; -use time::macros::format_description; -use time::{Duration, OffsetDateTime, UtcOffset}; +use jiff::{Span, Timestamp, Unit}; use crate::api::Message; use crate::bot::command::{ClapCommand, Command, Context}; use crate::conn; -pub fn format_time(t: OffsetDateTime) -> String { - let t = t.to_offset(UtcOffset::UTC); - let format = format_description!("[year]-[month]-[day] [hour]:[minute]:[second] UTC"); - t.format(format).unwrap() +pub fn format_time(t: Timestamp) -> String { + t.strftime("%Y-%m-%d %H:%M:%S UTC").to_string() } -pub fn format_duration(d: Duration) -> String { - let d_abs = d.abs(); - let days = d_abs.whole_days(); - let hours = d_abs.whole_hours() % 24; - let mins = d_abs.whole_minutes() % 60; - let secs = d_abs.whole_seconds() % 60; +pub fn format_relative_time(d: Span) -> String { + if d.is_positive() { + format!("in {}", format_duration(d.abs())) + } else { + format!("{} ago", format_duration(d.abs())) + } +} + +pub fn format_duration(d: Span) -> String { + let total = d.abs().total(Unit::Second).unwrap() as i64; + let secs = total % 60; + let mins = (total / 60) % 60; + let hours = (total / 60 / 60) % 24; + let days = total / 60 / 60 / 24; let mut segments = vec![]; if days > 0 { @@ -39,27 +44,27 @@ pub fn format_duration(d: Duration) -> String { let segments = segments.join(" "); if d.is_positive() { - format!("in {segments}") + segments } else { - format!("{segments} ago") + format!("-{segments}") } } pub struct Uptime; pub trait HasStartTime { - fn start_time(&self) -> OffsetDateTime; + fn start_time(&self) -> Timestamp; } impl Uptime { fn formulate_reply(&self, ctx: &Context, bot: &B, connected: bool) -> String { let start = bot.start_time(); - let now = OffsetDateTime::now_utc(); + let now = Timestamp::now(); let mut reply = format!( "/me has been up since {} ({})", format_time(start), - format_duration(start - now), + format_relative_time(start - now), ); if connected { @@ -67,7 +72,7 @@ impl Uptime { reply.push_str(&format!( ", connected since {} ({})", format_time(since), - format_duration(since - now), + format_relative_time(since - now), )); } @@ -103,7 +108,7 @@ where pub struct Args { /// Show how long the bot has been connected without interruption. #[arg(long, short)] - connected: bool, + pub connected: bool, } #[async_trait] diff --git a/src/conn.rs b/src/conn.rs index 92d083c..7255d60 100644 --- a/src/conn.rs +++ b/src/conn.rs @@ -6,8 +6,8 @@ use std::future::Future; use std::time::{Duration, Instant}; use std::{error, fmt, result}; -use ::time::OffsetDateTime; use futures_util::SinkExt; +use jiff::Timestamp; use log::debug; use tokio::net::TcpStream; use tokio::select; @@ -75,7 +75,7 @@ pub type Result = result::Result; #[derive(Debug, Clone)] pub struct Joining { - pub since: OffsetDateTime, + pub since: Timestamp, pub hello: Option, pub snapshot: Option, pub bounce: Option, @@ -84,7 +84,7 @@ pub struct Joining { impl Joining { fn new() -> Self { Self { - since: OffsetDateTime::now_utc(), + since: Timestamp::now(), hello: None, snapshot: None, bounce: None, @@ -122,7 +122,7 @@ impl Joining { .map(|s| (s.session_id.clone(), SessionInfo::Full(s))) .collect::>(); Some(Joined { - since: OffsetDateTime::now_utc(), + since: Timestamp::now(), session, account: hello.account.clone(), listing, @@ -164,7 +164,7 @@ impl SessionInfo { #[derive(Debug, Clone)] pub struct Joined { - pub since: OffsetDateTime, + pub since: Timestamp, pub session: SessionView, pub account: Option, pub listing: HashMap, @@ -427,7 +427,7 @@ impl Conn { } tungstenite::Message::Ping(_) => {} tungstenite::Message::Pong(payload) => { - if self.last_ws_ping_payload == Some(payload) { + if self.last_ws_ping_payload == Some(payload.to_vec()) { self.last_ws_ping_replied_to = true; } } @@ -522,16 +522,18 @@ impl Conn { self.disconnect().await?; } - let now = OffsetDateTime::now_utc(); + let now = Timestamp::now(); // Send new ws ping - let ws_payload = now.unix_timestamp_nanos().to_be_bytes().to_vec(); + let ws_payload = now.as_millisecond().to_be_bytes().to_vec(); self.last_ws_ping_payload = Some(ws_payload.clone()); self.last_ws_ping_replied_to = false; - self.ws.send(tungstenite::Message::Ping(ws_payload)).await?; + self.ws + .send(tungstenite::Message::Ping(ws_payload.into())) + .await?; // Send new euph ping - let euph_payload = Time::new(now); + let euph_payload = Time::from_timestamp(now); self.last_euph_ping_payload = Some(euph_payload); self.last_euph_ping_replied_to = false; let (tx, _) = oneshot::channel(); @@ -561,7 +563,7 @@ impl Conn { .into_packet()?; debug!(target: "euphoxide::conn::full", "Sending {packet:?}"); - let msg = tungstenite::Message::Text(serde_json::to_string(&packet)?); + let msg = tungstenite::Message::Text(serde_json::to_string(&packet)?.into()); self.ws.send(msg).await?; let _ = reply_tx.send(self.replies.wait_for(id)); @@ -579,7 +581,7 @@ impl Conn { .into_packet()?; debug!(target: "euphoxide::conn::full", "Sending {packet:?}"); - let msg = tungstenite::Message::Text(serde_json::to_string(&packet)?); + let msg = tungstenite::Message::Text(serde_json::to_string(&packet)?.into()); self.ws.send(msg).await?; Ok(()) diff --git a/src/emoji.json b/src/emoji.json index e9f8068..b26a1f7 100644 --- a/src/emoji.json +++ b/src/emoji.json @@ -878,7 +878,7 @@ "fist_raised": "270a", "fist_right": "1f91c", "five": "35-fe0f-20e3", - "fjafjkldskf7jkfdj": "1f577", + "fjafjkldskf7jkfdj": "1f577-fe0f", "flags": "1f38f", "flamingo": "1f9a9", "flashlight": "1f526", @@ -958,6 +958,7 @@ "georgia": "1f1ec-1f1ea", "ghana": "1f1ec-1f1ed", "ghost": "1f47b", + "ghoti": "1f41f", "gibraltar": "1f1ec-1f1ee", "gift": "1f381", "gift_heart": "1f49d", @@ -2985,7 +2986,7 @@ "speaking_head": "1f5e3-fe0f", "speech_balloon": "1f4ac", "speedboat": "1f6a4", - "spider": "1f577", + "spider": "1f577-fe0f", "spider_web": "1f578-fe0f", "spiral_calendar": "1f5d3-fe0f", "spiral_notepad": "1f5d2-fe0f", diff --git a/src/lib.rs b/src/lib.rs index 66fb34e..380b321 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,14 +1,3 @@ -#![forbid(unsafe_code)] -// Rustc lint groups -#![warn(future_incompatible)] -#![warn(rust_2018_idioms)] -#![warn(unused)] -// Rustc lints -#![warn(noop_method_call)] -#![warn(single_use_lifetimes)] -// Clippy lints -#![warn(clippy::use_self)] - pub mod api; #[cfg(feature = "bot")] pub mod bot; diff --git a/src/nick.rs b/src/nick.rs index 03ada70..fc652bf 100644 --- a/src/nick.rs +++ b/src/nick.rs @@ -5,9 +5,10 @@ use unicode_normalization::UnicodeNormalization; use crate::emoji::Emoji; -/// Does not remove emoji. -fn hue_normalize(text: &str) -> String { - text.chars() +fn hue_normalize(emoji: &Emoji, text: &str) -> String { + emoji + .remove(text) + .chars() .filter(|&c| c.is_ascii_alphanumeric() || c == '_' || c == '-') .map(|c| c.to_ascii_lowercase()) .collect() @@ -15,7 +16,7 @@ fn hue_normalize(text: &str) -> String { /// A re-implementation of [euphoria's nick hue hashing algorithm][0]. /// -/// [0]: https://github.com/CylonicRaider/heim/blob/master/client/lib/hueHash.js +/// [0]: https://github.com/CylonicRaider/heim/blob/097a1fde89ada53de2b70e51e635257f27956e4e/client/lib/heim/hueHash.js fn hue_hash(text: &str, offset: i64) -> u8 { let mut val = 0_i32; for bibyte in text.encode_utf16() { @@ -35,7 +36,13 @@ const GREENIE_OFFSET: i64 = 148 - 192; // 148 - hue_hash("greenie", 0) /// This should be slightly faster than [`hue`] but produces incorrect results /// if any colon-delimited emoji are present. pub fn hue_without_removing_emoji(nick: &str) -> u8 { - let normalized = hue_normalize(nick); + // An emoji-less version of hue_normalize + let normalized = nick + .chars() + .filter(|&c| c.is_ascii_alphanumeric() || c == '_' || c == '-') + .map(|c| c.to_ascii_lowercase()) + .collect::(); + if normalized.is_empty() { hue_hash(nick, GREENIE_OFFSET) } else { @@ -48,9 +55,14 @@ pub fn hue_without_removing_emoji(nick: &str) -> u8 { /// This is a reimplementation of [euphoria's nick hue hashing algorithm][0]. It /// should always return the same value as the official client's implementation. /// -/// [0]: https://github.com/CylonicRaider/heim/blob/978c921063e6b06012fc8d16d9fbf1b3a0be1191/client/lib/hueHash.js +/// [0]: https://github.com/CylonicRaider/heim/blob/097a1fde89ada53de2b70e51e635257f27956e4e/client/lib/heim/hueHash.js pub fn hue(emoji: &Emoji, nick: &str) -> u8 { - hue_without_removing_emoji(&emoji.remove(nick)) + let normalized = hue_normalize(emoji, nick); + if normalized.is_empty() { + hue_hash(nick, GREENIE_OFFSET) + } else { + hue_hash(&normalized, GREENIE_OFFSET) + } } /// Normalize a nick to a form that can be compared against other nicks.