char
/
matrix-rust-sdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Move mutating methods from RoomMember to Room. 

The `update_profile` method cannot live in `RoomMember` since that
operation needs information which only exists in `Room` (for instance,
it needs other members in order to perform display name disambiguation).

Leaving other mutating methods on `RoomMember` (like `update_power` and
`update_presence`) then seemed illogical so they were all moved into
`Room`.

In addition, a small refactoring was done to remove
`did_update_presence` and `update_presence` since their existence
doesn't make much sense anymore and it saves us from repeating work.
Their function is now done in `receive_presence_event`.

Also, several docstrings were corrected and reworded.
master
Denis Kasak 2020-07-01 15:44:44 +02:00
parent 5f49dab1fa
commit eeebb43e32
2 changed files with 95 additions and 111 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
matrix_sdk_base/src/models/room.rs
View File

@ -23,7 +23,7 @@ use super::RoomMember;
use crate::api::r0::sync::sync_events::{RoomSummary, UnreadNotificationsCount};
use crate::events::collections::all::{RoomEvent, StateEvent};
use crate::events::presence::PresenceEvent;
use crate::events::presence::{PresenceEvent, PresenceEventContent};
use crate::events::room::{
aliases::AliasesEvent,
canonical_alias::CanonicalAliasEvent,
@ -584,22 +584,14 @@ impl Room {
use MembershipChange::*;
match event.membership_change() {
Invited | Joined => self.add_member(event),
Invited | Joined => {
self.add_member(event)
}
Kicked | Banned | KickedAndBanned | InvitationRejected | Left => {
self.remove_member(event)
}
ProfileChanged => {
let user_id = if let Ok(id) = UserId::try_from(event.state_key.as_str()) {
id
} else {
return false;
};
if let Some(member) = self.joined_members.get_mut(&user_id) {
member.update_profile(event)
} else {
false
}
self.update_member_profile(event)
}
// Not interested in other events.
@ -671,11 +663,12 @@ impl Room {
for user in event.content.users.keys() {
if let Some(member) = self.joined_members.get_mut(user) {
if member.update_power(event, max_power) {
if Room::update_member_power(member, event, max_power) {
updated = true;
}
}
}
updated
}
@ -755,28 +748,106 @@ impl Room {
}
}
/// Receive a presence event from an `IncomingResponse` and updates the client state.
/// Receive a presence event for a member of the current room.
///
/// This will only update the user if found in the current room looped through
/// by `Client::sync`.
/// Returns true if the specific users presence has changed, false otherwise.
/// Returns true if the event causes a change to the member's presence, false otherwise.
///
/// # Arguments
///
/// * `event` - The presence event to receive and process.
pub fn receive_presence_event(&mut self, event: &PresenceEvent) -> bool {
let PresenceEvent {
content:
PresenceEventContent {
avatar_url,
currently_active,
displayname,
last_active_ago,
presence,
status_msg,
},
..
} = event;
if let Some(member) = self.joined_members.get_mut(&event.sender) {
if member.did_update_presence(event) {
if member.display_name == *displayname
&& member.avatar_url == *avatar_url
&& member.presence.as_ref() == Some(presence)
&& member.status_msg == *status_msg
&& member.last_active_ago == *last_active_ago
&& member.currently_active == *currently_active {
// Everything is the same, nothing to do.
false
} else {
member.update_presence(event);
// Something changed, do the update.
member.presence_events.push(event.clone());
member.avatar_url = avatar_url.clone();
member.currently_active = *currently_active;
member.display_name = displayname.clone();
member.last_active_ago = *last_active_ago;
member.presence = Some(*presence);
member.status_msg = status_msg.clone();
true
}
} else {
// this is probably an error as we have a `PresenceEvent` for a user
// we don't know about
// This is probably an error as we have a `PresenceEvent` for a user
// we don't know about.
false
}
}
/// Process an update of a member's profile.
///
/// # Arguments
///
/// * `event` - The profile update event for a specified room member.
// TODO: NEXT: Add disambiguation handling here
pub(crate) fn update_member_profile(&mut self, event: &MemberEvent) -> bool {
let user_id = if let Ok(id) = UserId::try_from(event.state_key.as_str()) {
id
} else {
return false;
};
if let Some(member) = self.joined_members.get_mut(&user_id) {
member.display_name = event.content.displayname.clone();
member.avatar_url = event.content.avatar_url.clone();
true
} else if let Some(member) = self.invited_members.get_mut(&user_id) {
member.display_name = event.content.displayname.clone();
member.avatar_url = event.content.avatar_url.clone();
true
} else {
false
}
}
/// Process an update of a member's power level.
///
/// # Arguments
///
/// * `event` - The power level event to process.
/// * `max_power` - Maximum power level allowed.
pub fn update_member_power(member: &mut RoomMember, event: &PowerLevelsEvent, max_power: Int) -> bool {
let changed;
if let Some(user_power) = event.content.users.get(&member.user_id) {
changed = member.power_level != Some(*user_power);
member.power_level = Some(*user_power);
} else {
changed = member.power_level != Some(event.content.users_default);
member.power_level = Some(event.content.users_default);
}
if max_power > Int::from(0) {
member.power_level_norm = Some((member.power_level.unwrap() * Int::from(100)) / max_power);
}
changed
}
}

91
matrix_sdk_base/src/models/room_member.rs
View File

@ -16,11 +16,8 @@
use std::convert::TryFrom;
use crate::events::collections::all::Event;
use crate::events::presence::{PresenceEvent, PresenceEventContent, PresenceState};
use crate::events::room::{
member::MemberEvent,
power_levels::PowerLevelsEvent,
};
use crate::events::presence::{PresenceEvent, PresenceState};
use crate::events::room::member::MemberEvent;
use crate::identifiers::UserId;
use crate::js_int::{Int, UInt};
@ -123,90 +120,6 @@ impl RoomMember {
.map(|d| format!("{} ({})", d, self.user_id))
.unwrap_or_else(|| format!("{}", self.user_id))
}
/// Handle profile updates.
// TODO: NEXT: Add disambiguation handling here
pub(crate) fn update_profile(&mut self, event: &MemberEvent) -> bool {
self.display_name = event.content.displayname.clone();
self.avatar_url = event.content.avatar_url.clone();
true
}
pub fn update_power(&mut self, event: &PowerLevelsEvent, max_power: Int) -> bool {
let changed;
if let Some(user_power) = event.content.users.get(&self.user_id) {
changed = self.power_level != Some(*user_power);
self.power_level = Some(*user_power);
} else {
changed = self.power_level != Some(event.content.users_default);
self.power_level = Some(event.content.users_default);
}
if max_power > Int::from(0) {
self.power_level_norm = Some((self.power_level.unwrap() * Int::from(100)) / max_power);
}
changed
}
/// If the current `PresenceEvent` updated the state of this `RoomMember`.
///
/// Returns true if the member's presence has changed, false otherwise.
///
/// # Arguments
///
/// * `presence` - The presence event for this room member.
pub fn did_update_presence(&self, presence: &PresenceEvent) -> bool {
let PresenceEvent {
content:
PresenceEventContent {
avatar_url,
currently_active,
displayname,
last_active_ago,
presence,
status_msg,
},
..
} = presence;
self.display_name == *displayname
&& self.avatar_url == *avatar_url
&& self.presence.as_ref() == Some(presence)
&& self.status_msg == *status_msg
&& self.last_active_ago == *last_active_ago
&& self.currently_active == *currently_active
}
/// Updates the `RoomMember`'s presence.
///
/// This should only be used if `did_update_presence` was true.
///
/// # Arguments
///
/// * `presence` - The presence event for this room member.
pub fn update_presence(&mut self, presence_ev: &PresenceEvent) {
let PresenceEvent {
content:
PresenceEventContent {
avatar_url,
currently_active,
displayname,
last_active_ago,
presence,
status_msg,
},
..
} = presence_ev;
self.presence_events.push(presence_ev.clone());
self.avatar_url = avatar_url.clone();
self.currently_active = *currently_active;
self.display_name = displayname.clone();
self.last_active_ago = *last_active_ago;
self.presence = Some(*presence);
self.status_msg = status_msg.clone();
}
}
#[cfg(test)]