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 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
//! Matrix room identifiers.
use ruma_macros::IdZst;
use super::{
matrix_uri::UriAction, MatrixToUri, MatrixUri, OwnedEventId, OwnedServerName, ServerName,
};
use crate::RoomOrAliasId;
/// A Matrix [room ID].
///
/// A `RoomId` is generated randomly or converted from a string slice, and can be converted back
/// into a string as needed.
///
/// ```
/// # use ruma_common::RoomId;
/// assert_eq!(<&RoomId>::try_from("!n8f893n9:example.com").unwrap(), "!n8f893n9:example.com");
/// ```
///
/// [room ID]: https://spec.matrix.org/latest/appendices/#room-ids
#[repr(transparent)]
#[derive(PartialEq, Eq, PartialOrd, Ord, Hash, IdZst)]
#[ruma_id(validate = ruma_identifiers_validation::room_id::validate)]
pub struct RoomId(str);
impl RoomId {
/// Attempts to generate a `RoomId` for the given origin server with a localpart consisting of
/// 18 random ASCII characters.
///
/// Fails if the given homeserver cannot be parsed as a valid host.
#[cfg(feature = "rand")]
#[allow(clippy::new_ret_no_self)]
pub fn new(server_name: &ServerName) -> OwnedRoomId {
Self::from_borrowed(&format!("!{}:{server_name}", super::generate_localpart(18))).to_owned()
}
/// Returns the server name of the room ID.
pub fn server_name(&self) -> Option<&ServerName> {
<&RoomOrAliasId>::from(self).server_name()
}
/// Create a `matrix.to` URI for this room ID.
///
/// Note that it is recommended to provide servers that should know the room to be able to find
/// it with its room ID. For that use [`RoomId::matrix_to_uri_via()`].
///
/// # Example
///
/// ```
/// use ruma_common::{room_id, server_name};
///
/// assert_eq!(
/// room_id!("!somewhere:example.org").matrix_to_uri().to_string(),
/// "https://matrix.to/#/!somewhere:example.org"
/// );
/// ```
pub fn matrix_to_uri(&self) -> MatrixToUri {
MatrixToUri::new(self.into(), vec![])
}
/// Create a `matrix.to` URI for this room ID with a list of servers that should know it.
///
/// To get the list of servers, it is recommended to use the [routing algorithm] from the spec.
///
/// If you don't have a list of servers, you can use [`RoomId::matrix_to_uri()`] instead.
///
/// # Example
///
/// ```
/// use ruma_common::{room_id, server_name};
///
/// assert_eq!(
/// room_id!("!somewhere:example.org")
/// .matrix_to_uri_via([&*server_name!("example.org"), &*server_name!("alt.example.org")])
/// .to_string(),
/// "https://matrix.to/#/!somewhere:example.org?via=example.org&via=alt.example.org"
/// );
/// ```
///
/// [routing algorithm]: https://spec.matrix.org/latest/appendices/#routing
pub fn matrix_to_uri_via<T>(&self, via: T) -> MatrixToUri
where
T: IntoIterator,
T::Item: Into<OwnedServerName>,
{
MatrixToUri::new(self.into(), via.into_iter().map(Into::into).collect())
}
/// Create a `matrix.to` URI for an event scoped under this room ID.
///
/// Note that it is recommended to provide servers that should know the room to be able to find
/// it with its room ID. For that use [`RoomId::matrix_to_event_uri_via()`].
pub fn matrix_to_event_uri(&self, ev_id: impl Into<OwnedEventId>) -> MatrixToUri {
MatrixToUri::new((self.to_owned(), ev_id.into()).into(), vec![])
}
/// Create a `matrix.to` URI for an event scoped under this room ID with a list of servers that
/// should know it.
///
/// To get the list of servers, it is recommended to use the [routing algorithm] from the spec.
///
/// If you don't have a list of servers, you can use [`RoomId::matrix_to_event_uri()`] instead.
///
/// [routing algorithm]: https://spec.matrix.org/latest/appendices/#routing
pub fn matrix_to_event_uri_via<T>(&self, ev_id: impl Into<OwnedEventId>, via: T) -> MatrixToUri
where
T: IntoIterator,
T::Item: Into<OwnedServerName>,
{
MatrixToUri::new(
(self.to_owned(), ev_id.into()).into(),
via.into_iter().map(Into::into).collect(),
)
}
/// Create a `matrix:` URI for this room ID.
///
/// If `join` is `true`, a click on the URI should join the room.
///
/// Note that it is recommended to provide servers that should know the room to be able to find
/// it with its room ID. For that use [`RoomId::matrix_uri_via()`].
///
/// # Example
///
/// ```
/// use ruma_common::{room_id, server_name};
///
/// assert_eq!(
/// room_id!("!somewhere:example.org").matrix_uri(false).to_string(),
/// "matrix:roomid/somewhere:example.org"
/// );
/// ```
pub fn matrix_uri(&self, join: bool) -> MatrixUri {
MatrixUri::new(self.into(), vec![], Some(UriAction::Join).filter(|_| join))
}
/// Create a `matrix:` URI for this room ID with a list of servers that should know it.
///
/// To get the list of servers, it is recommended to use the [routing algorithm] from the spec.
///
/// If you don't have a list of servers, you can use [`RoomId::matrix_uri()`] instead.
///
/// If `join` is `true`, a click on the URI should join the room.
///
/// # Example
///
/// ```
/// use ruma_common::{room_id, server_name};
///
/// assert_eq!(
/// room_id!("!somewhere:example.org")
/// .matrix_uri_via(
/// [&*server_name!("example.org"), &*server_name!("alt.example.org")],
/// true
/// )
/// .to_string(),
/// "matrix:roomid/somewhere:example.org?via=example.org&via=alt.example.org&action=join"
/// );
/// ```
///
/// [routing algorithm]: https://spec.matrix.org/latest/appendices/#routing
pub fn matrix_uri_via<T>(&self, via: T, join: bool) -> MatrixUri
where
T: IntoIterator,
T::Item: Into<OwnedServerName>,
{
MatrixUri::new(
self.into(),
via.into_iter().map(Into::into).collect(),
Some(UriAction::Join).filter(|_| join),
)
}
/// Create a `matrix:` URI for an event scoped under this room ID.
///
/// Note that it is recommended to provide servers that should know the room to be able to find
/// it with its room ID. For that use [`RoomId::matrix_event_uri_via()`].
pub fn matrix_event_uri(&self, ev_id: impl Into<OwnedEventId>) -> MatrixUri {
MatrixUri::new((self.to_owned(), ev_id.into()).into(), vec![], None)
}
/// Create a `matrix:` URI for an event scoped under this room ID with a list of servers that
/// should know it.
///
/// To get the list of servers, it is recommended to use the [routing algorithm] from the spec.
///
/// If you don't have a list of servers, you can use [`RoomId::matrix_event_uri()`] instead.
///
/// [routing algorithm]: https://spec.matrix.org/latest/appendices/#routing
pub fn matrix_event_uri_via<T>(&self, ev_id: impl Into<OwnedEventId>, via: T) -> MatrixUri
where
T: IntoIterator,
T::Item: Into<OwnedServerName>,
{
MatrixUri::new(
(self.to_owned(), ev_id.into()).into(),
via.into_iter().map(Into::into).collect(),
None,
)
}
}
#[cfg(test)]
mod tests {
use super::{OwnedRoomId, RoomId};
use crate::{server_name, IdParseError};
#[test]
fn valid_room_id() {
let room_id =
<&RoomId>::try_from("!29fhd83h92h0:example.com").expect("Failed to create RoomId.");
assert_eq!(room_id, "!29fhd83h92h0:example.com");
}
#[test]
fn empty_localpart() {
let room_id = <&RoomId>::try_from("!:example.com").expect("Failed to create RoomId.");
assert_eq!(room_id, "!:example.com");
assert_eq!(room_id.server_name(), Some(server_name!("example.com")));
}
#[cfg(feature = "rand")]
#[test]
fn generate_random_valid_room_id() {
let room_id = RoomId::new(server_name!("example.com"));
let id_str = room_id.as_str();
assert!(id_str.starts_with('!'));
assert_eq!(id_str.len(), 31);
}
#[test]
fn serialize_valid_room_id() {
assert_eq!(
serde_json::to_string(
<&RoomId>::try_from("!29fhd83h92h0:example.com").expect("Failed to create RoomId.")
)
.expect("Failed to convert RoomId to JSON."),
r#""!29fhd83h92h0:example.com""#
);
}
#[test]
fn deserialize_valid_room_id() {
assert_eq!(
serde_json::from_str::<OwnedRoomId>(r#""!29fhd83h92h0:example.com""#)
.expect("Failed to convert JSON to RoomId"),
<&RoomId>::try_from("!29fhd83h92h0:example.com").expect("Failed to create RoomId.")
);
}
#[test]
fn valid_room_id_with_explicit_standard_port() {
let room_id =
<&RoomId>::try_from("!29fhd83h92h0:example.com:443").expect("Failed to create RoomId.");
assert_eq!(room_id, "!29fhd83h92h0:example.com:443");
assert_eq!(room_id.server_name(), Some(server_name!("example.com:443")));
}
#[test]
fn valid_room_id_with_non_standard_port() {
assert_eq!(
<&RoomId>::try_from("!29fhd83h92h0:example.com:5000")
.expect("Failed to create RoomId."),
"!29fhd83h92h0:example.com:5000"
);
}
#[test]
fn missing_room_id_sigil() {
assert_eq!(
<&RoomId>::try_from("carl:example.com").unwrap_err(),
IdParseError::MissingLeadingSigil
);
}
#[test]
fn missing_server_name() {
let room_id = <&RoomId>::try_from("!29fhd83h92h0").expect("Failed to create RoomId.");
assert_eq!(room_id, "!29fhd83h92h0");
assert_eq!(room_id.server_name(), None);
}
#[test]
fn invalid_room_id_host() {
let room_id = <&RoomId>::try_from("!29fhd83h92h0:/").expect("Failed to create RoomId.");
assert_eq!(room_id, "!29fhd83h92h0:/");
assert_eq!(room_id.server_name(), None);
}
#[test]
fn invalid_room_id_port() {
let room_id = <&RoomId>::try_from("!29fhd83h92h0:example.com:notaport")
.expect("Failed to create RoomId.");
assert_eq!(room_id, "!29fhd83h92h0:example.com:notaport");
assert_eq!(room_id.server_name(), None);
}
}