You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
302 lines
8.1 KiB
302 lines
8.1 KiB
use std::collections::HashMap;
|
|
use std::mem;
|
|
|
|
use log::{error, info, warn};
|
|
use solstice_proto::{server, User};
|
|
use thiserror::Error;
|
|
|
|
use crate::room::{RoomMembership, RoomState, RoomVisibility};
|
|
|
|
/// The error returned by RoomMap functions.
|
|
#[derive(Debug, Error)]
|
|
pub enum RoomError {
|
|
#[error(transparent)]
|
|
RoomNotFound(#[from] RoomNotFoundError),
|
|
|
|
#[error("cannot change membership from {0:?} to {1:?}")]
|
|
MembershipChangeInvalid(RoomMembership, RoomMembership),
|
|
}
|
|
|
|
#[derive(Debug, Error)]
|
|
#[error("room {0} not found")]
|
|
pub struct RoomNotFoundError(String);
|
|
|
|
/// Contains the mapping from room names to room data and provides a clean
|
|
/// interface to interact with it.
|
|
#[derive(Debug, Default)]
|
|
pub struct RoomMap {
|
|
/// The actual map from room names to room data.
|
|
map: HashMap<String, RoomState>,
|
|
}
|
|
|
|
impl RoomMap {
|
|
/// Creates an empty mapping.
|
|
pub fn new() -> Self {
|
|
Self::default()
|
|
}
|
|
|
|
/// Inserts the given room in the map under the given name.
|
|
/// Same semantics as `std::collections::HashMap::insert()`.
|
|
pub fn insert(&mut self, name: String, room: RoomState) -> Option<RoomState> {
|
|
self.map.insert(name, room)
|
|
}
|
|
|
|
/// Looks up the given room name in the map, returning an immutable
|
|
/// reference to the associated data if found, or an error if not found.
|
|
pub fn get_strict(
|
|
&self,
|
|
room_name: &str,
|
|
) -> Result<&RoomState, RoomNotFoundError> {
|
|
match self.map.get(room_name) {
|
|
Some(room) => Ok(room),
|
|
None => Err(RoomNotFoundError(room_name.to_string())),
|
|
}
|
|
}
|
|
|
|
/// Looks up the given room name in the map, returning a mutable
|
|
/// reference to the associated data if found, or an error if not found.
|
|
pub fn get_mut_strict(
|
|
&mut self,
|
|
room_name: &str,
|
|
) -> Result<&mut RoomState, RoomNotFoundError> {
|
|
match self.map.get_mut(room_name) {
|
|
Some(room) => Ok(room),
|
|
None => Err(RoomNotFoundError(room_name.to_string())),
|
|
}
|
|
}
|
|
|
|
/// Updates one room in the map based on the information received in
|
|
/// a RoomListResponse and the potential previously stored information.
|
|
fn update_one(
|
|
&mut self,
|
|
name: String,
|
|
visibility: RoomVisibility,
|
|
user_count: u32,
|
|
old_map: &mut HashMap<String, RoomState>,
|
|
) {
|
|
let room = match old_map.remove(&name) {
|
|
None => RoomState::new(RoomVisibility::Public, user_count as usize),
|
|
Some(mut room) => {
|
|
room.visibility = visibility;
|
|
room.user_count = user_count as usize;
|
|
room
|
|
}
|
|
};
|
|
if let Some(_) = self.insert(name, room) {
|
|
error!("Room present twice in room list response");
|
|
}
|
|
}
|
|
|
|
/// Updates the map to reflect the information contained in the given
|
|
/// server response.
|
|
pub fn set_room_list(&mut self, mut response: server::RoomListResponse) {
|
|
// Replace the old mapping with an empty one.
|
|
let mut old_map = mem::replace(&mut self.map, HashMap::new());
|
|
|
|
// Add all public rooms.
|
|
for (name, user_count) in response.rooms.drain(..) {
|
|
self.update_one(name, RoomVisibility::Public, user_count, &mut old_map);
|
|
}
|
|
|
|
// Add all private, owned, rooms.
|
|
for (name, user_count) in response.owned_private_rooms.drain(..) {
|
|
self.update_one(
|
|
name,
|
|
RoomVisibility::PrivateOwned,
|
|
user_count,
|
|
&mut old_map,
|
|
);
|
|
}
|
|
|
|
// Add all private, unowned, rooms.
|
|
for (name, user_count) in response.other_private_rooms.drain(..) {
|
|
self.update_one(
|
|
name,
|
|
RoomVisibility::PrivateOther,
|
|
user_count,
|
|
&mut old_map,
|
|
);
|
|
}
|
|
|
|
// Mark all operated rooms as necessary.
|
|
for name in response.operated_private_room_names.iter() {
|
|
match self.map.get_mut(name) {
|
|
Some(room) => room.operated = true,
|
|
None => error!("Room {} is operated but does not exist", name),
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Returns the list of (room name, room data) representing all known rooms.
|
|
pub fn get_room_list(&self) -> Vec<(String, RoomState)> {
|
|
let mut rooms = Vec::new();
|
|
for (room_name, room) in self.map.iter() {
|
|
rooms.push((room_name.clone(), room.clone()));
|
|
}
|
|
rooms
|
|
}
|
|
|
|
/// Records that we are now trying to join the given room.
|
|
/// If the room is not found, or if its membership is not `NonMember`,
|
|
/// returns an error.
|
|
pub fn start_joining(&mut self, room_name: &str) -> Result<(), RoomError> {
|
|
let room = self.get_mut_strict(room_name)?;
|
|
|
|
match room.membership {
|
|
RoomMembership::NonMember => {
|
|
room.membership = RoomMembership::Joining;
|
|
Ok(())
|
|
}
|
|
|
|
membership => Err(RoomError::MembershipChangeInvalid(
|
|
membership,
|
|
RoomMembership::Joining,
|
|
)),
|
|
}
|
|
}
|
|
|
|
/// Records that we are now a member of the given room and updates the room
|
|
/// information.
|
|
pub fn join(
|
|
&mut self,
|
|
room_name: &str,
|
|
owner: Option<String>,
|
|
mut operators: Vec<String>,
|
|
members: &[User],
|
|
) -> Result<&RoomState, RoomError> {
|
|
// First look up the room struct.
|
|
let room = self.get_mut_strict(room_name)?;
|
|
|
|
// Log what's happening.
|
|
if let RoomMembership::Joining = room.membership {
|
|
info!("Joined room {:?}", room_name);
|
|
} else {
|
|
warn!(
|
|
"Joined room {:?} but membership was already {:?}",
|
|
room_name, room.membership
|
|
);
|
|
}
|
|
|
|
// Update the room struct.
|
|
room.membership = RoomMembership::Member;
|
|
room.user_count = members.len();
|
|
room.owner = owner;
|
|
|
|
room.operators.clear();
|
|
for user_name in operators.drain(..) {
|
|
room.operators.insert(user_name);
|
|
}
|
|
|
|
room.members.clear();
|
|
for user in members {
|
|
room.members.insert(user.name.clone());
|
|
}
|
|
|
|
Ok(room)
|
|
}
|
|
|
|
#[allow(dead_code)]
|
|
/// Records that we are now trying to leave the given room.
|
|
/// If the room is not found, or if its membership status is not `Member`,
|
|
/// returns an error.
|
|
pub fn start_leaving(&mut self, room_name: &str) -> Result<(), RoomError> {
|
|
let room = self.get_mut_strict(room_name)?;
|
|
|
|
match room.membership {
|
|
RoomMembership::Member => {
|
|
room.membership = RoomMembership::Leaving;
|
|
Ok(())
|
|
}
|
|
|
|
membership => Err(RoomError::MembershipChangeInvalid(
|
|
membership,
|
|
RoomMembership::Leaving,
|
|
)),
|
|
}
|
|
}
|
|
|
|
/// Records that we have now left the given room.
|
|
pub fn leave(&mut self, room_name: &str) -> Result<(), RoomError> {
|
|
let room = self.get_mut_strict(room_name)?;
|
|
|
|
match room.membership {
|
|
RoomMembership::Leaving => info!("Left room {:?}", room_name),
|
|
|
|
membership => warn!(
|
|
"Left room {:?} with wrong membership: {:?}",
|
|
room_name, membership
|
|
),
|
|
}
|
|
|
|
room.membership = RoomMembership::NonMember;
|
|
Ok(())
|
|
}
|
|
|
|
/// Inserts the given user in the given room's set of members.
|
|
/// Returns an error if the room is not found.
|
|
pub fn insert_member(
|
|
&mut self,
|
|
room_name: &str,
|
|
user_name: String,
|
|
) -> Result<(), RoomError> {
|
|
let room = self.get_mut_strict(room_name)?;
|
|
room.members.insert(user_name);
|
|
Ok(())
|
|
}
|
|
|
|
/// Removes the given user from the given room's set of members.
|
|
/// Returns an error if the room is not found.
|
|
pub fn remove_member(
|
|
&mut self,
|
|
room_name: &str,
|
|
user_name: &str,
|
|
) -> Result<(), RoomError> {
|
|
let room = self.get_mut_strict(room_name)?;
|
|
room.members.remove(user_name);
|
|
Ok(())
|
|
}
|
|
|
|
/*---------*
|
|
* Tickers *
|
|
*---------*/
|
|
|
|
pub fn set_tickers(
|
|
&mut self,
|
|
room_name: &str,
|
|
tickers: Vec<(String, String)>,
|
|
) -> Result<(), RoomError> {
|
|
let room = self.get_mut_strict(room_name)?;
|
|
room.tickers = tickers;
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use solstice_proto::server::RoomListResponse;
|
|
|
|
use crate::room::{RoomState, RoomVisibility};
|
|
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn new_is_empty() {
|
|
assert_eq!(RoomMap::new().get_room_list(), vec![]);
|
|
}
|
|
|
|
#[test]
|
|
fn get_strict() {
|
|
let mut rooms = RoomMap::new();
|
|
rooms.set_room_list(RoomListResponse {
|
|
rooms: vec![("room a".to_string(), 42), ("room b".to_string(), 1337)],
|
|
owned_private_rooms: vec![],
|
|
other_private_rooms: vec![],
|
|
operated_private_room_names: vec![],
|
|
});
|
|
|
|
assert_eq!(
|
|
rooms.get_strict("room a").unwrap(),
|
|
&RoomState::new(RoomVisibility::Public, 42)
|
|
);
|
|
}
|
|
}
|