Implement room clearing, log to info for member updates.

.#.drone.yml

@@ -1 +0,0 @@
-jeff@seraph.10585:1603007115

src/bot.rs

@@ -4,27 +4,25 @@ use crate::context::Context;
 use crate::db::Database;
 use crate::error::BotError;
 use crate::state::DiceBotState;
-use async_trait::async_trait;
 use dirs;
-use log::{debug, error, info, warn};
+use log::{error, info};
 use matrix_sdk::Error as MatrixError;
 use matrix_sdk::{
     self,
     events::{
-        room::member::MemberEventContent,
-        room::message::{MessageEventContent, NoticeMessageEventContent, TextMessageEventContent},
-        AnyMessageEventContent, StrippedStateEvent, SyncMessageEvent,
+        room::message::{MessageEventContent, NoticeMessageEventContent},
+        AnyMessageEventContent,
     },
-    Client, ClientConfig, EventEmitter, JsonStore, Room, SyncRoom, SyncSettings,
+    Client, ClientConfig, JsonStore, Room, SyncSettings,
 };
 //use matrix_sdk_common_macros::async_trait;
 use std::clone::Clone;
-use std::ops::Sub;
 use std::path::PathBuf;
 use std::sync::{Arc, RwLock};
-use std::time::{Duration, SystemTime};
 use url::Url;
 
+pub mod event_handlers;
+
 /// The DiceBot struct represents an active dice bot. The bot is not
 /// connected to Matrix until its run() function is called.
 pub struct DiceBot {
@@ -176,104 +174,3 @@ impl DiceBot {
         }
     }
 }
-
-/// Check if a message is recent enough to actually process. If the
-/// message is within "oldest_message_age" seconds, this function
-/// returns true. If it's older than that, it returns false and logs a
-/// debug message.
-fn check_message_age(
-    event: &SyncMessageEvent<MessageEventContent>,
-    oldest_message_age: u64,
-) -> bool {
-    let sending_time = event.origin_server_ts;
-    let oldest_timestamp = SystemTime::now().sub(Duration::new(oldest_message_age, 0));
-
-    if sending_time > oldest_timestamp {
-        true
-    } else {
-        let age = match oldest_timestamp.duration_since(sending_time) {
-            Ok(n) => format!("{} seconds too old", n.as_secs()),
-            Err(_) => "before the UNIX epoch".to_owned(),
-        };
-
-        debug!("Ignoring message because it is {}: {:?}", age, event);
-        false
-    }
-}
-
-async fn should_process<'a>(
-    bot: &DiceBot,
-    event: &SyncMessageEvent<MessageEventContent>,
-) -> Result<(String, String), BotError> {
-    //Ignore messages that are older than configured duration.
-    if !check_message_age(event, bot.config.oldest_message_age()) {
-        let state_check = bot.state.read().unwrap();
-        if !((*state_check).logged_skipped_old_messages()) {
-            drop(state_check);
-            let mut state = bot.state.write().unwrap();
-            (*state).skipped_old_messages();
-        }
-
-        return Err(BotError::ShouldNotProcessError);
-    }
-
-    let (msg_body, sender_username) = if let SyncMessageEvent {
-        content: MessageEventContent::Text(TextMessageEventContent { body, .. }),
-        sender,
-        ..
-    } = event
-    {
-        (
-            body.clone(),
-            format!("@{}:{}", sender.localpart(), sender.server_name()),
-        )
-    } else {
-        (String::new(), String::new())
-    };
-
-    Ok((msg_body, sender_username))
-}
-
-/// This event emitter listens for messages with dice rolling commands.
-/// Originally adapted from the matrix-rust-sdk examples.
-#[async_trait]
-impl EventEmitter for DiceBot {
-    async fn on_stripped_state_member(
-        &self,
-        room: SyncRoom,
-        room_member: &StrippedStateEvent<MemberEventContent>,
-        _: Option<MemberEventContent>,
-    ) {
-        if let SyncRoom::Invited(room) = room {
-            if let Some(user_id) = self.client.user_id().await {
-                if room_member.state_key != user_id {
-                    return;
-                }
-            }
-
-            let room = room.read().await;
-            info!("Autojoining room {}", room.display_name());
-
-            if let Err(e) = self.client.join_room_by_id(&room.room_id).await {
-                warn!("Could not join room: {}", e.to_string())
-            }
-        }
-    }
-
-    async fn on_room_message(&self, room: SyncRoom, event: &SyncMessageEvent<MessageEventContent>) {
-        if let SyncRoom::Joined(room) = room {
-            let (msg_body, sender_username) =
-                if let Ok((msg_body, sender_username)) = should_process(self, &event).await {
-                    (msg_body, sender_username)
-                } else {
-                    return;
-                };
-
-            //we clone here to hold the lock for as little time as possible.
-            let real_room = room.read().await.clone();
-
-            self.execute_commands(&real_room, &sender_username, &msg_body)
-                .await;
-        }
-    }
-}

src/bot/event_handlers.rs

@@ -0,0 +1,163 @@
+use crate::error::BotError;
+use async_trait::async_trait;
+use log::{debug, error, info, warn};
+use matrix_sdk::{
+    self,
+    events::{
+        room::member::{MemberEventContent, MembershipState},
+        room::message::{MessageEventContent, TextMessageEventContent},
+        StrippedStateEvent, SyncMessageEvent, SyncStateEvent,
+    },
+    EventEmitter, SyncRoom,
+};
+//use matrix_sdk_common_macros::async_trait;
+use super::DiceBot;
+use std::clone::Clone;
+use std::ops::Sub;
+use std::time::{Duration, SystemTime};
+
+/// Check if a message is recent enough to actually process. If the
+/// message is within "oldest_message_age" seconds, this function
+/// returns true. If it's older than that, it returns false and logs a
+/// debug message.
+fn check_message_age(
+    event: &SyncMessageEvent<MessageEventContent>,
+    oldest_message_age: u64,
+) -> bool {
+    let sending_time = event.origin_server_ts;
+    let oldest_timestamp = SystemTime::now().sub(Duration::new(oldest_message_age, 0));
+
+    if sending_time > oldest_timestamp {
+        true
+    } else {
+        let age = match oldest_timestamp.duration_since(sending_time) {
+            Ok(n) => format!("{} seconds too old", n.as_secs()),
+            Err(_) => "before the UNIX epoch".to_owned(),
+        };
+
+        debug!("Ignoring message because it is {}: {:?}", age, event);
+        false
+    }
+}
+
+async fn should_process<'a>(
+    bot: &DiceBot,
+    event: &SyncMessageEvent<MessageEventContent>,
+) -> Result<(String, String), BotError> {
+    //Ignore messages that are older than configured duration.
+    if !check_message_age(event, bot.config.oldest_message_age()) {
+        let state_check = bot.state.read().unwrap();
+        if !((*state_check).logged_skipped_old_messages()) {
+            drop(state_check);
+            let mut state = bot.state.write().unwrap();
+            (*state).skipped_old_messages();
+        }
+
+        return Err(BotError::ShouldNotProcessError);
+    }
+
+    let (msg_body, sender_username) = if let SyncMessageEvent {
+        content: MessageEventContent::Text(TextMessageEventContent { body, .. }),
+        sender,
+        ..
+    } = event
+    {
+        (
+            body.clone(),
+            format!("@{}:{}", sender.localpart(), sender.server_name()),
+        )
+    } else {
+        (String::new(), String::new())
+    };
+
+    Ok((msg_body, sender_username))
+}
+
+/// This event emitter listens for messages with dice rolling commands.
+/// Originally adapted from the matrix-rust-sdk examples.
+#[async_trait]
+impl EventEmitter for DiceBot {
+    async fn on_room_member(
+        &self,
+        room: SyncRoom,
+        room_member: &SyncStateEvent<MemberEventContent>,
+    ) {
+        if let SyncRoom::Joined(room) = room {
+            let event_affects_us = if let Some(our_user_id) = self.client.user_id().await {
+                room_member.state_key == our_user_id
+            } else {
+                false
+            };
+
+            let adding_user = match room_member.content.membership {
+                MembershipState::Join => true,
+                MembershipState::Leave | MembershipState::Ban => false,
+                _ => return,
+            };
+
+            //Clone to avoid holding lock.
+            let room = room.read().await.clone();
+            let (room_id, username) = (room.room_id.as_str(), &room_member.state_key);
+
+            let result = if event_affects_us && !adding_user {
+                info!("Clearing all information for room ID {}", room_id);
+                self.db.rooms.clear_info(room_id)
+            } else if !event_affects_us && adding_user {
+                info!("Adding user {} to room ID {}", username, room_id);
+                self.db.rooms.add_user_to_room(username, room_id)
+            } else if !event_affects_us && !adding_user {
+                info!("Removing user {} from room ID {}", username, room_id);
+                self.db.rooms.remove_user_from_room(username, room_id)
+            } else {
+                debug!("Ignoring a room member event: {:#?}", room_member);
+                Ok(())
+            };
+
+            if let Err(e) = result {
+                error!("Could not update room information: {}", e.to_string());
+            } else {
+                debug!("Successfully processed room member update.");
+            }
+        }
+    }
+
+    async fn on_stripped_state_member(
+        &self,
+        room: SyncRoom,
+        room_member: &StrippedStateEvent<MemberEventContent>,
+        _: Option<MemberEventContent>,
+    ) {
+        if let SyncRoom::Invited(room) = room {
+            if let Some(user_id) = self.client.user_id().await {
+                if room_member.state_key != user_id {
+                    return;
+                }
+            }
+
+            //Clone to avoid holding lock.
+            let room = room.read().await.clone();
+            info!("Autojoining room {}", room.display_name());
+
+            if let Err(e) = self.client.join_room_by_id(&room.room_id).await {
+                warn!("Could not join room: {}", e.to_string())
+            }
+        }
+    }
+
+    async fn on_room_message(&self, room: SyncRoom, event: &SyncMessageEvent<MessageEventContent>) {
+        if let SyncRoom::Joined(room) = room {
+            let (msg_body, sender_username) =
+                if let Ok((msg_body, sender_username)) = should_process(self, &event).await {
+                    (msg_body, sender_username)
+                } else {
+                    return;
+                };
+
+            //we clone here to hold the lock for as little time as possible.
+            let real_room = room.read().await.clone();
+
+            self.execute_commands(&real_room, &sender_username, &msg_body)
+                .await;
+        }
+    }
+}

src/db.rs

@@ -1,5 +1,6 @@
 use crate::db::errors::{DataError, MigrationError};
 use crate::db::migrations::{get_migration_version, Migrations};
+use crate::db::rooms::Rooms;
 use crate::db::variables::Variables;
 use log::info;
 use sled::{Config, Db};
@@ -8,6 +9,7 @@ use std::path::Path;
 pub mod data_migrations;
 pub mod errors;
 pub mod migrations;
+pub mod rooms;
 pub mod schema;
 pub mod variables;
 
@@ -16,6 +18,7 @@ pub struct Database {
     db: Db,
     pub(crate) variables: Variables,
     pub(crate) migrations: Migrations,
+    pub(crate) rooms: Rooms,
 }
 
 impl Database {
@@ -26,6 +29,7 @@ impl Database {
             db: db.clone(),
             variables: Variables::new(&db)?,
             migrations: Migrations(migrations),
+            rooms: Rooms::new(&db)?,
         })
     }
 

src/db/errors.rs

@@ -62,13 +62,11 @@ impl From<TransactionError<DataError>> for DataError {
     }
 }
 
-// impl From<ConflictableTransactionError<DataError>> for DataError {
-//     fn from(error: ConflictableTransactionError<DataError>) -> Self {
-//         match error {
-//             ConflictableTransactionError::Abort(data_err) => data_err,
-//             ConflictableTransactionError::Storage(storage_err) => {
-//                 DataError::TransactionError(TransactionError::Storage(storage_err))
-//             }
-//         }
-//     }
-// }
+/// Automatically aborts transactions that hit a DataError by using
+/// the try (question mark) operator when this trait implementation is
+/// in scope.
+impl From<DataError> for sled::transaction::ConflictableTransactionError<DataError> {
+    fn from(error: DataError) -> Self {
+        sled::transaction::ConflictableTransactionError::Abort(error)
+    }
+}

src/db/rooms.rs

@@ -0,0 +1,249 @@
+use crate::db::errors::DataError;
+use sled::transaction::TransactionalTree;
+use sled::Transactional;
+use sled::Tree;
+use std::collections::HashSet;
+use std::str;
+
+#[derive(Clone)]
+pub struct Rooms {
+    /// Room ID -> RoomInfo struct (single entries)
+    pub(in crate::db) roomid_roominfo: Tree,
+
+    /// Room ID -> list of usernames in room.
+    pub(in crate::db) roomid_usernames: Tree,
+
+    /// Username -> list of room IDs user is in.
+    pub(in crate::db) username_roomids: Tree,
+}
+
+#[derive(Clone, Copy)]
+enum TxableTree<'a> {
+    Tree(&'a Tree),
+    Tx(&'a TransactionalTree),
+}
+
+impl<'a> Into<TxableTree<'a>> for &'a Tree {
+    fn into(self) -> TxableTree<'a> {
+        TxableTree::Tree(self)
+    }
+}
+
+impl<'a> Into<TxableTree<'a>> for &'a TransactionalTree {
+    fn into(self) -> TxableTree<'a> {
+        TxableTree::Tx(self)
+    }
+}
+
+fn get_set<'a, T: Into<TxableTree<'a>>>(tree: T, key: &[u8]) -> Result<HashSet<String>, DataError> {
+    let set: HashSet<String> = match tree.into() {
+        TxableTree::Tree(tree) => tree.get(key)?,
+        TxableTree::Tx(tx) => tx.get(key)?,
+    }
+    .map(|bytes| bincode::deserialize::<HashSet<String>>(&bytes))
+    .unwrap_or(Ok(HashSet::new()))?;
+
+    Ok(set)
+}
+
+fn remove_from_set<'a, T: Into<TxableTree<'a>> + Copy>(
+    tree: T,
+    key: &[u8],
+    value_to_remove: &str,
+) -> Result<(), DataError> {
+    let mut set = get_set(tree, key)?;
+    set.remove(value_to_remove);
+    insert_set(tree, key, set)?;
+    Ok(())
+}
+
+fn insert_set<'a, T: Into<TxableTree<'a>>>(
+    tree: T,
+    key: &[u8],
+    set: HashSet<String>,
+) -> Result<(), DataError> {
+    let serialized = bincode::serialize(&set)?;
+    match tree.into() {
+        TxableTree::Tree(tree) => tree.insert(key, serialized)?,
+        TxableTree::Tx(tx) => tx.insert(key, serialized)?,
+    };
+    Ok(())
+}
+
+impl Rooms {
+    pub(in crate::db) fn new(db: &sled::Db) -> Result<Rooms, sled::Error> {
+        Ok(Rooms {
+            roomid_roominfo: db.open_tree("roomid_roominfo")?,
+            roomid_usernames: db.open_tree("roomid_usernames")?,
+            username_roomids: db.open_tree("username_roomids")?,
+        })
+    }
+
+    pub fn get_rooms_for_user(&self, username: &str) -> Result<HashSet<String>, DataError> {
+        get_set(&self.username_roomids, username.as_bytes())
+    }
+
+    pub fn get_users_in_room(&self, room_id: &str) -> Result<HashSet<String>, DataError> {
+        get_set(&self.roomid_usernames, room_id.as_bytes())
+    }
+
+    pub fn add_user_to_room(&self, username: &str, room_id: &str) -> Result<(), DataError> {
+        (&self.username_roomids, &self.roomid_usernames).transaction(
+            |(tx_username_rooms, tx_room_usernames)| {
+                let username_key = &username.as_bytes();
+                let mut user_to_rooms = get_set(tx_username_rooms, username_key)?;
+                user_to_rooms.insert(room_id.to_string());
+                insert_set(tx_username_rooms, username_key, user_to_rooms)?;
+
+                let roomid_key = &room_id.as_bytes();
+                let mut room_to_users = get_set(tx_room_usernames, roomid_key)?;
+                room_to_users.insert(username.to_string());
+                insert_set(tx_room_usernames, roomid_key, room_to_users)?;
+
+                Ok(())
+            },
+        )?;
+
+        Ok(())
+    }
+
+    pub fn remove_user_from_room(&self, username: &str, room_id: &str) -> Result<(), DataError> {
+        (&self.username_roomids, &self.roomid_usernames).transaction(
+            |(tx_username_rooms, tx_room_usernames)| {
+                let username_key = &username.as_bytes();
+                let mut user_to_rooms = get_set(tx_username_rooms, username_key)?;
+                user_to_rooms.remove(room_id);
+                insert_set(tx_username_rooms, username_key, user_to_rooms)?;
+
+                let roomid_key = &room_id.as_bytes();
+                let mut room_to_users = get_set(tx_room_usernames, roomid_key)?;
+                room_to_users.remove(username);
+                insert_set(tx_room_usernames, roomid_key, room_to_users)?;
+
+                Ok(())
+            },
+        )?;
+
+        Ok(())
+    }
+
+    pub fn clear_info(&self, room_id: &str) -> Result<(), DataError> {
+        (&self.username_roomids, &self.roomid_usernames).transaction(
+            |(tx_username_roomids, tx_roomid_usernames)| {
+                let roomid_key = room_id.as_bytes();
+                let users_in_room = get_set(tx_roomid_usernames, roomid_key)?;
+
+                //Remove the room ID from every user's room ID list.
+                for username in users_in_room {
+                    remove_from_set(tx_username_roomids, username.as_bytes(), room_id)?;
+                }
+
+                //Remove this room entry for the room ID -> username tree.
+                tx_roomid_usernames.remove(roomid_key)?;
+
+                //TODO: delete roominfo struct from room info tree.
+                Ok(())
+            },
+        )?;
+
+        Ok(())
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use sled::Config;
+
+    fn create_test_instance() -> Rooms {
+        let config = Config::new().temporary(true);
+        let db = config.open().unwrap();
+        Rooms::new(&db).unwrap()
+    }
+
+    #[test]
+    fn add_user_to_room() {
+        let rooms = create_test_instance();
+        rooms
+            .add_user_to_room("testuser", "myroom")
+            .expect("Could not add user to room");
+
+        let users_in_room = rooms
+            .get_users_in_room("myroom")
+            .expect("Could not retrieve users in room");
+
+        let rooms_for_user = rooms
+            .get_rooms_for_user("testuser")
+            .expect("Could not get rooms for user");
+
+        let expected_users_in_room: HashSet<String> =
+            vec![String::from("testuser")].into_iter().collect();
+
+        let expected_rooms_for_user: HashSet<String> =
+            vec![String::from("myroom")].into_iter().collect();
+
+        assert_eq!(expected_users_in_room, users_in_room);
+        assert_eq!(expected_rooms_for_user, rooms_for_user);
+    }
+
+    #[test]
+    fn remove_user_from_room() {
+        let rooms = create_test_instance();
+        rooms
+            .add_user_to_room("testuser", "myroom")
+            .expect("Could not add user to room");
+
+        rooms
+            .remove_user_from_room("testuser", "myroom")
+            .expect("Could not remove user from room");
+
+        let users_in_room = rooms
+            .get_users_in_room("myroom")
+            .expect("Could not retrieve users in room");
+
+        let rooms_for_user = rooms
+            .get_rooms_for_user("testuser")
+            .expect("Could not get rooms for user");
+
+        assert_eq!(HashSet::new(), users_in_room);
+        assert_eq!(HashSet::new(), rooms_for_user);
+    }
+
+    #[test]
+    fn clear_info() {
+        let rooms = create_test_instance();
+        rooms
+            .add_user_to_room("testuser", "myroom1")
+            .expect("Could not add user to room1");
+
+        rooms
+            .add_user_to_room("testuser", "myroom2")
+            .expect("Could not add user to room2");
+
+        rooms
+            .clear_info("myroom1")
+            .expect("Could not clear room info");
+
+        let users_in_room1 = rooms
+            .get_users_in_room("myroom1")
+            .expect("Could not retrieve users in room1");
+
+        let users_in_room2 = rooms
+            .get_users_in_room("myroom2")
+            .expect("Could not retrieve users in room2");
+
+        let rooms_for_user = rooms
+            .get_rooms_for_user("testuser")
+            .expect("Could not get rooms for user");
+
+        let expected_users_in_room2: HashSet<String> =
+            vec![String::from("testuser")].into_iter().collect();
+
+        let expected_rooms_for_user: HashSet<String> =
+            vec![String::from("myroom2")].into_iter().collect();
+
+        assert_eq!(HashSet::new(), users_in_room1);
+        assert_eq!(expected_users_in_room2, users_in_room2);
+        assert_eq!(expected_rooms_for_user, rooms_for_user);
+    }
+}

src/lib.rs

@@ -9,6 +9,7 @@ pub mod db;
 pub mod dice;
 pub mod error;
 mod help;
+pub mod models;
 mod parser;
 pub mod state;
 pub mod variables;

src/models.rs

@@ -0,0 +1,5 @@
+/// RoomInfo has basic metadata about a room: its name, ID, etc.
+pub struct RoomInfo {
+    pub room_id: String,
+    pub room_name: String,
+}