feat(presence): implement presence functionality

src/service/globals/mod.rs

@@ -367,6 +367,18 @@ impl Service {
         &self.config.emergency_password
     }
 
+    pub fn allow_presence(&self) -> bool {
+        self.config.allow_presence
+    }
+
+    pub fn presence_idle_timeout_s(&self) -> u64 {
+        self.config.presence_idle_timeout_s
+    }
+
+    pub fn presence_offline_timeout_s(&self) -> u64 {
+        self.config.presence_offline_timeout_s
+    }
+
     pub fn supported_room_versions(&self) -> Vec<RoomVersionId> {
         let mut room_versions: Vec<RoomVersionId> = vec![];
         room_versions.extend(self.stable_room_versions.clone());

src/service/rooms/edus/presence/data.rs

@@ -1,38 +1,33 @@
-use std::collections::HashMap;
-
 use crate::Result;
-use ruma::{events::presence::PresenceEvent, OwnedUserId, RoomId, UserId};
+use ruma::{
+    events::presence::PresenceEvent, presence::PresenceState, OwnedUserId, RoomId, UInt, UserId,
+};
 
 pub trait Data: Send + Sync {
+    /// Returns the latest presence event for the given user in the given room.
+    fn get_presence(&self, room_id: &RoomId, user_id: &UserId) -> Result<Option<PresenceEvent>>;
+
+    /// Pings the presence of the given user in the given room, setting the specified state.
+    fn ping_presence(&self, user_id: &UserId, new_state: PresenceState) -> Result<()>;
+
     /// Adds a presence event which will be saved until a new event replaces it.
-    ///
-    /// Note: This method takes a RoomId because presence updates are always bound to rooms to
-    /// make sure users outside these rooms can't see them.
-    fn update_presence(
+    fn set_presence(
         &self,
-        user_id: &UserId,
         room_id: &RoomId,
-        presence: PresenceEvent,
+        user_id: &UserId,
+        presence_state: PresenceState,
+        currently_active: Option<bool>,
+        last_active_ago: Option<UInt>,
+        status_msg: Option<String>,
     ) -> Result<()>;
 
-    /// Resets the presence timeout, so the user will stay in their current presence state.
-    fn ping_presence(&self, user_id: &UserId) -> Result<()>;
-
-    /// Returns the timestamp of the last presence update of this user in millis since the unix epoch.
-    fn last_presence_update(&self, user_id: &UserId) -> Result<Option<u64>>;
-
-    /// Returns the presence event with correct last_active_ago.
-    fn get_presence_event(
-        &self,
-        room_id: &RoomId,
-        user_id: &UserId,
-        count: u64,
-    ) -> Result<Option<PresenceEvent>>;
+    /// Removes the presence record for the given user from the database.
+    fn remove_presence(&self, user_id: &UserId) -> Result<()>;
 
     /// Returns the most recent presence updates that happened after the event with id `since`.
-    fn presence_since(
-        &self,
+    fn presence_since<'a>(
+        &'a self,
         room_id: &RoomId,
         since: u64,
-    ) -> Result<HashMap<OwnedUserId, PresenceEvent>>;
+    ) -> Box<dyn Iterator<Item = Result<(OwnedUserId, u64, PresenceEvent)>> + 'a>;
 }

src/service/rooms/edus/presence/mod.rs

@@ -1,122 +1,211 @@
 mod data;
-use std::collections::HashMap;
+
+use std::time::Duration;
 
 pub use data::Data;
-use ruma::{events::presence::PresenceEvent, OwnedUserId, RoomId, UserId};
+use futures_util::{stream::FuturesUnordered, StreamExt};
+use ruma::{
+    events::presence::{PresenceEvent, PresenceEventContent},
+    presence::PresenceState,
+    OwnedUserId, RoomId, UInt, UserId,
+};
+use serde::{Deserialize, Serialize};
+use tokio::{sync::mpsc, time::sleep};
+use tracing::debug;
 
-use crate::Result;
+use crate::{services, utils, Error, Result};
+
+/// Represents data required to be kept in order to implement the presence specification.
+#[derive(Serialize, Deserialize, Debug, Clone)]
+pub struct Presence {
+    pub state: PresenceState,
+    pub currently_active: bool,
+    pub last_active_ts: u64,
+    pub last_count: u64,
+    pub status_msg: Option<String>,
+}
+
+impl Presence {
+    pub fn new(
+        state: PresenceState,
+        currently_active: bool,
+        last_active_ts: u64,
+        last_count: u64,
+        status_msg: Option<String>,
+    ) -> Self {
+        Self {
+            state,
+            currently_active,
+            last_active_ts,
+            last_count,
+            status_msg,
+        }
+    }
+
+    pub fn from_json_bytes(bytes: &[u8]) -> Result<Self> {
+        serde_json::from_slice(bytes)
+            .map_err(|_| Error::bad_database("Invalid presence data in database"))
+    }
+
+    pub fn to_json_bytes(&self) -> Result<Vec<u8>> {
+        serde_json::to_vec(self)
+            .map_err(|_| Error::bad_database("Could not serialize Presence to JSON"))
+    }
+
+    /// Creates a PresenceEvent from available data.
+    pub fn to_presence_event(&self, user_id: &UserId) -> Result<PresenceEvent> {
+        let now = utils::millis_since_unix_epoch();
+        let last_active_ago = if self.currently_active {
+            None
+        } else {
+            Some(UInt::new_saturating(
+                now.saturating_sub(self.last_active_ts),
+            ))
+        };
+
+        Ok(PresenceEvent {
+            sender: user_id.to_owned(),
+            content: PresenceEventContent {
+                presence: self.state.clone(),
+                status_msg: self.status_msg.clone(),
+                currently_active: Some(self.currently_active),
+                last_active_ago,
+                displayname: services().users.displayname(user_id)?,
+                avatar_url: services().users.avatar_url(user_id)?,
+            },
+        })
+    }
+}
 
 pub struct Service {
     pub db: &'static dyn Data,
 }
 
 impl Service {
-    /// Adds a presence event which will be saved until a new event replaces it.
-    ///
-    /// Note: This method takes a RoomId because presence updates are always bound to rooms to
-    /// make sure users outside these rooms can't see them.
-    pub fn update_presence(
+    /// Returns the latest presence event for the given user in the given room.
+    pub fn get_presence(
         &self,
-        user_id: &UserId,
         room_id: &RoomId,
-        presence: PresenceEvent,
-    ) -> Result<()> {
-        self.db.update_presence(user_id, room_id, presence)
-    }
-
-    /// Resets the presence timeout, so the user will stay in their current presence state.
-    pub fn ping_presence(&self, user_id: &UserId) -> Result<()> {
-        self.db.ping_presence(user_id)
-    }
-
-    pub fn get_last_presence_event(
-        &self,
         user_id: &UserId,
-        room_id: &RoomId,
     ) -> Result<Option<PresenceEvent>> {
-        let last_update = match self.db.last_presence_update(user_id)? {
-            Some(last) => last,
-            None => return Ok(None),
-        };
-
-        self.db.get_presence_event(room_id, user_id, last_update)
+        self.db.get_presence(room_id, user_id)
     }
 
-    /* TODO
-    /// Sets all users to offline who have been quiet for too long.
-    fn _presence_maintain(
+    /// Pings the presence of the given user in the given room, setting the specified state.
+    pub fn ping_presence(&self, user_id: &UserId, new_state: PresenceState) -> Result<()> {
+        self.db.ping_presence(user_id, new_state)
+    }
+
+    /// Adds a presence event which will be saved until a new event replaces it.
+    pub fn set_presence(
         &self,
-        rooms: &super::Rooms,
-        globals: &super::super::globals::Globals,
+        room_id: &RoomId,
+        user_id: &UserId,
+        presence_state: PresenceState,
+        currently_active: Option<bool>,
+        last_active_ago: Option<UInt>,
+        status_msg: Option<String>,
     ) -> Result<()> {
-        let current_timestamp = utils::millis_since_unix_epoch();
+        self.db.set_presence(
+            room_id,
+            user_id,
+            presence_state,
+            currently_active,
+            last_active_ago,
+            status_msg,
+        )
+    }
 
-        for (user_id_bytes, last_timestamp) in self
-            .userid_lastpresenceupdate
-            .iter()
-            .filter_map(|(k, bytes)| {
-                Some((
-                    k,
-                    utils::u64_from_bytes(&bytes)
-                        .map_err(|_| {
-                            Error::bad_database("Invalid timestamp in userid_lastpresenceupdate.")
-                        })
-                        .ok()?,
-                ))
-            })
-            .take_while(|(_, timestamp)| current_timestamp.saturating_sub(*timestamp) > 5 * 60_000)
-        // 5 Minutes
-        {
-            // Send new presence events to set the user offline
-            let count = globals.next_count()?.to_be_bytes();
-            let user_id: Box<_> = utils::string_from_bytes(&user_id_bytes)
-                .map_err(|_| {
-                    Error::bad_database("Invalid UserId bytes in userid_lastpresenceupdate.")
-                })?
-                .try_into()
-                .map_err(|_| Error::bad_database("Invalid UserId in userid_lastpresenceupdate."))?;
-            for room_id in rooms.rooms_joined(&user_id).filter_map(|r| r.ok()) {
-                let mut presence_id = room_id.as_bytes().to_vec();
-                presence_id.push(0xff);
-                presence_id.extend_from_slice(&count);
-                presence_id.push(0xff);
-                presence_id.extend_from_slice(&user_id_bytes);
-
-                self.presenceid_presence.insert(
-                    &presence_id,
-                    &serde_json::to_vec(&PresenceEvent {
-                        content: PresenceEventContent {
-                            avatar_url: None,
-                            currently_active: None,
-                            displayname: None,
-                            last_active_ago: Some(
-                                last_timestamp.try_into().expect("time is valid"),
-                            ),
-                            presence: PresenceState::Offline,
-                            status_msg: None,
-                        },
-                        sender: user_id.to_owned(),
-                    })
-                    .expect("PresenceEvent can be serialized"),
-                )?;
-            }
-
-            self.userid_lastpresenceupdate.insert(
-                user_id.as_bytes(),
-                &utils::millis_since_unix_epoch().to_be_bytes(),
-            )?;
-        }
-
-        Ok(())
-    }*/
+    /// Removes the presence record for the given user from the database.
+    pub fn remove_presence(&self, user_id: &UserId) -> Result<()> {
+        self.db.remove_presence(user_id)
+    }
 
     /// Returns the most recent presence updates that happened after the event with id `since`.
-    #[tracing::instrument(skip(self, since, room_id))]
-    pub fn presence_since(
-        &self,
+    pub fn presence_since<'a>(
+        &'a self,
         room_id: &RoomId,
         since: u64,
-    ) -> Result<HashMap<OwnedUserId, PresenceEvent>> {
+    ) -> Box<dyn Iterator<Item = Result<(OwnedUserId, u64, PresenceEvent)>> + 'a> {
         self.db.presence_since(room_id, since)
     }
 }
+
+pub async fn presence_handler(
+    mut presence_timer_receiver: mpsc::UnboundedReceiver<(OwnedUserId, Duration)>,
+) -> Result<()> {
+    let mut presence_timers = FuturesUnordered::new();
+
+    loop {
+        debug!("Number of presence timers: {}", presence_timers.len());
+
+        tokio::select! {
+            Some((user_id, timeout)) = presence_timer_receiver.recv() => {
+                debug!("Adding timer for user '{user_id}': Timeout {timeout:?}");
+                presence_timers.push(presence_timer(user_id, timeout));
+            }
+
+            Some(user_id) = presence_timers.next() => {
+                process_presence_timer(user_id)?;
+            }
+        }
+    }
+}
+
+async fn presence_timer(user_id: OwnedUserId, timeout: Duration) -> OwnedUserId {
+    sleep(timeout).await;
+
+    user_id
+}
+
+fn process_presence_timer(user_id: OwnedUserId) -> Result<()> {
+    let idle_timeout = services().globals.config.presence_idle_timeout_s * 1_000;
+    let offline_timeout = services().globals.config.presence_offline_timeout_s * 1_000;
+
+    let mut presence_state = PresenceState::Offline;
+    let mut last_active_ago = None;
+    let mut status_msg = None;
+
+    for room_id in services().rooms.state_cache.rooms_joined(&user_id) {
+        let presence_event = services()
+            .rooms
+            .edus
+            .presence
+            .get_presence(&room_id?, &user_id)?;
+
+        if let Some(presence_event) = presence_event {
+            presence_state = presence_event.content.presence;
+            last_active_ago = presence_event.content.last_active_ago;
+            status_msg = presence_event.content.status_msg;
+
+            break;
+        }
+    }
+
+    let new_state = match (&presence_state, last_active_ago.map(|ago| u64::from(ago))) {
+        (PresenceState::Online, Some(ago)) if ago >= idle_timeout => {
+            Some(PresenceState::Unavailable)
+        }
+        (PresenceState::Unavailable, Some(ago)) if ago >= offline_timeout => {
+            Some(PresenceState::Offline)
+        }
+        _ => None,
+    };
+
+    debug!("Processed presence timer for user '{user_id}': Old state = {presence_state}, New state = {new_state:?}");
+
+    if let Some(new_state) = new_state {
+        for room_id in services().rooms.state_cache.rooms_joined(&user_id) {
+            services().rooms.edus.presence.set_presence(
+                &room_id?,
+                &user_id,
+                new_state.clone(),
+                Some(false),
+                last_active_ago,
+                status_msg.clone(),
+            )?;
+        }
+    }
+
+    Ok(())
+}

src/service/sending/mod.rs

@@ -26,7 +26,8 @@ use ruma::{
         federation::{
             self,
             transactions::edu::{
-                DeviceListUpdateContent, Edu, ReceiptContent, ReceiptData, ReceiptMap,
+                DeviceListUpdateContent, Edu, PresenceContent, PresenceUpdate, ReceiptContent,
+                ReceiptData, ReceiptMap,
             },
         },
         OutgoingRequest,
@@ -285,6 +286,39 @@ impl Service {
                     .filter(|user_id| user_id.server_name() == services().globals.server_name()),
             );
 
+            // Look for presence updates in this room
+            let mut presence_updates = Vec::new();
+
+            for presence_data in services()
+                .rooms
+                .edus
+                .presence
+                .presence_since(&room_id, since)
+            {
+                let (user_id, count, presence_event) = presence_data?;
+
+                if count > max_edu_count {
+                    max_edu_count = count;
+                }
+
+                if user_id.server_name() != services().globals.server_name() {
+                    continue;
+                }
+
+                presence_updates.push(PresenceUpdate {
+                    user_id,
+                    presence: presence_event.content.presence,
+                    currently_active: presence_event.content.currently_active.unwrap_or(false),
+                    last_active_ago: presence_event.content.last_active_ago.unwrap_or(uint!(0)),
+                    status_msg: presence_event.content.status_msg,
+                });
+            }
+
+            let presence_content = Edu::Presence(PresenceContent::new(presence_updates));
+            events.push(
+                serde_json::to_vec(&presence_content).expect("PresenceEvent can be serialized"),
+            );
+
             // Look for read receipts in this room
             for r in services()
                 .rooms