1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
// Copyright 2024 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! Preview of a room, whether we've joined it/left it/been invited to it, or
//! not.
//!
//! This offers a few capabilities for previewing the content of the room as
//! well.
use matrix_sdk_base::{RoomInfo, RoomState};
use ruma::{
api::client::{membership::joined_members, state::get_state_events},
events::room::{history_visibility::HistoryVisibility, join_rules::JoinRule},
room::RoomType,
space::SpaceRoomJoinRule,
OwnedMxcUri, OwnedRoomAliasId, OwnedRoomId, OwnedServerName, RoomId, RoomOrAliasId,
};
use tokio::try_join;
use tracing::{instrument, warn};
use crate::{Client, Room};
/// The preview of a room, be it invited/joined/left, or not.
#[derive(Debug, Clone)]
pub struct RoomPreview {
/// The actual room id for this room.
///
/// Remember the room preview can be fetched from a room alias id, so we
/// might not know ahead of time what the room id is.
pub room_id: OwnedRoomId,
/// The canonical alias for the room.
pub canonical_alias: Option<OwnedRoomAliasId>,
/// The room's name, if set.
pub name: Option<String>,
/// The room's topic, if set.
pub topic: Option<String>,
/// The MXC URI to the room's avatar, if set.
pub avatar_url: Option<OwnedMxcUri>,
/// The number of joined members.
pub num_joined_members: u64,
/// The room type (space, custom) or nothing, if it's a regular room.
pub room_type: Option<RoomType>,
/// What's the join rule for this room?
pub join_rule: SpaceRoomJoinRule,
/// Is the room world-readable (i.e. is its history_visibility set to
/// world_readable)?
pub is_world_readable: bool,
/// Has the current user been invited/joined/left this room?
///
/// Set to `None` if the room is unknown to the user.
pub state: Option<RoomState>,
/// The `m.room.direct` state of the room, if known.
pub is_direct: Option<bool>,
}
impl RoomPreview {
/// Constructs a [`RoomPreview`] from the associated room info.
///
/// Note: not using the room info's state/count of joined members, because
/// we can do better than that.
fn from_room_info(
room_info: RoomInfo,
is_direct: Option<bool>,
num_joined_members: u64,
state: Option<RoomState>,
) -> Self {
RoomPreview {
room_id: room_info.room_id().to_owned(),
canonical_alias: room_info.canonical_alias().map(ToOwned::to_owned),
name: room_info.name().map(ToOwned::to_owned),
topic: room_info.topic().map(ToOwned::to_owned),
avatar_url: room_info.avatar_url().map(ToOwned::to_owned),
room_type: room_info.room_type().cloned(),
join_rule: match room_info.join_rule() {
JoinRule::Invite => SpaceRoomJoinRule::Invite,
JoinRule::Knock => SpaceRoomJoinRule::Knock,
JoinRule::Private => SpaceRoomJoinRule::Private,
JoinRule::Restricted(_) => SpaceRoomJoinRule::Restricted,
JoinRule::KnockRestricted(_) => SpaceRoomJoinRule::KnockRestricted,
JoinRule::Public => SpaceRoomJoinRule::Public,
_ => {
// The JoinRule enum is non-exhaustive. Let's do a white lie and pretend it's
// private (a cautious choice).
SpaceRoomJoinRule::Private
}
},
is_world_readable: *room_info.history_visibility() == HistoryVisibility::WorldReadable,
num_joined_members,
state,
is_direct,
}
}
/// Create a room preview from a known room (i.e. one we've been invited to,
/// we've joined or we've left).
pub(crate) async fn from_known(room: &Room) -> Self {
let is_direct = room.is_direct().await.ok();
Self::from_room_info(
room.clone_info(),
is_direct,
room.joined_members_count(),
Some(room.state()),
)
}
#[instrument(skip(client))]
pub(crate) async fn from_unknown(
client: &Client,
room_id: OwnedRoomId,
room_or_alias_id: &RoomOrAliasId,
via: Vec<OwnedServerName>,
) -> crate::Result<Self> {
// Use the room summary endpoint, if available, as described in
// https://github.com/deepbluev7/matrix-doc/blob/room-summaries/proposals/3266-room-summary.md
match Self::from_room_summary(client, room_id.clone(), room_or_alias_id, via).await {
Ok(res) => return Ok(res),
Err(err) => {
warn!("error when previewing room from the room summary endpoint: {err}");
}
}
// TODO: (optimization) Use the room search directory, if available:
// - if the room directory visibility is public,
// - then use a public room filter set to this room id
// Resort to using the room state endpoint, as well as the joined members one.
Self::from_state_events(client, &room_id).await
}
/// Get a [`RoomPreview`] using MSC3266, if available on the remote server.
///
/// Will fail with a 404 if the API is not available.
///
/// This method is exposed for testing purposes; clients should prefer
/// `Client::get_room_preview` in general over this.
pub async fn from_room_summary(
client: &Client,
room_id: OwnedRoomId,
room_or_alias_id: &RoomOrAliasId,
via: Vec<OwnedServerName>,
) -> crate::Result<Self> {
let request = ruma::api::client::room::get_summary::msc3266::Request::new(
room_or_alias_id.to_owned(),
via,
);
let response = client.send(request, None).await?;
// The server returns a `Left` room state for rooms the user has not joined. Be
// more precise than that, and set it to `None` if we haven't joined
// that room.
let cached_room = client.get_room(&room_id);
let state = if cached_room.is_none() {
None
} else {
response.membership.map(|membership| RoomState::from(&membership))
};
let is_direct = if let Some(cached_room) = cached_room {
cached_room.is_direct().await.ok()
} else {
None
};
Ok(RoomPreview {
room_id,
canonical_alias: response.canonical_alias,
name: response.name,
topic: response.topic,
avatar_url: response.avatar_url,
num_joined_members: response.num_joined_members.into(),
room_type: response.room_type,
join_rule: response.join_rule,
is_world_readable: response.world_readable,
state,
is_direct,
})
}
/// Get a [`RoomPreview`] using the room state endpoint.
///
/// This is always available on a remote server, but will only work if one
/// of these two conditions is true:
///
/// - the user has joined the room at some point (i.e. they're still joined
/// or they've joined it and left it later).
/// - the room has an history visibility set to world-readable.
///
/// This method is exposed for testing purposes; clients should prefer
/// `Client::get_room_preview` in general over this.
pub async fn from_state_events(client: &Client, room_id: &RoomId) -> crate::Result<Self> {
let state_request = get_state_events::v3::Request::new(room_id.to_owned());
let joined_members_request = joined_members::v3::Request::new(room_id.to_owned());
let (state, joined_members) =
try_join!(async { client.send(state_request, None).await }, async {
client.send(joined_members_request, None).await
})?;
// Converting from usize to u64 will always work, up to 64-bits devices;
// otherwise, assume LOTS of members.
let num_joined_members = joined_members.joined.len().try_into().unwrap_or(u64::MAX);
let mut room_info = RoomInfo::new(room_id, RoomState::Joined);
for ev in state.room_state {
let ev = match ev.deserialize() {
Ok(ev) => ev,
Err(err) => {
warn!("failed to deserialize state event: {err}");
continue;
}
};
room_info.handle_state_event(&ev.into());
}
let room = client.get_room(room_id);
let state = room.as_ref().map(|room| room.state());
let is_direct = if let Some(room) = room { room.is_direct().await.ok() } else { None };
Ok(Self::from_room_info(room_info, is_direct, num_joined_members, state))
}
}