Skip to main content

tuwunel_core/config/
room_version.rs

1//! Defines supported Matrix room-version policy.
2//!
3//! Stable, unstable, and experimental version lists are kept here. [`Config`]
4//! helpers apply the opt-in flags and report each enabled version's stability.
5
6use ruma::{
7	RoomVersionId,
8	api::{
9		client::discovery::get_capabilities::v3::RoomVersionStability,
10		error::{ErrorKind, IncompatibleRoomVersionErrorData},
11	},
12};
13
14use crate::{Config, Error, Result, implement};
15
16/// Partially supported non-compliant room versions
17pub const UNSTABLE_ROOM_VERSIONS: &[RoomVersionId] =
18	&[RoomVersionId::V3, RoomVersionId::V4, RoomVersionId::V5];
19
20/// Supported and stable room versions
21pub const STABLE_ROOM_VERSIONS: &[RoomVersionId] = &[
22	RoomVersionId::V6,
23	RoomVersionId::V7,
24	RoomVersionId::V8,
25	RoomVersionId::V9,
26	RoomVersionId::V10,
27	RoomVersionId::V11,
28	RoomVersionId::V12,
29];
30
31/// Experimental and prototype room versions under development.
32pub const EXPERIMENTAL_ROOM_VERSIONS: &[RoomVersionId] = &[];
33
34/// Refuses a room version this configuration does not enable.
35///
36/// The refusal is `M_INCOMPATIBLE_ROOM_VERSION`, whose `room_version` field
37/// names the refused version for the client or remote server.
38#[implement(Config)]
39pub fn require_supported_room_version(&self, version: &RoomVersionId) -> Result {
40	if !self.supported_room_version(version) {
41		let refused = IncompatibleRoomVersionErrorData::new(version.clone());
42
43		return Err(Error::BadRequest(
44			ErrorKind::IncompatibleRoomVersion(refused),
45			"Room version not supported.",
46		));
47	}
48
49	Ok(())
50}
51
52impl Config {
53	#[inline]
54	#[must_use]
55	/// Reports whether a room version is enabled by this configuration.
56	///
57	/// Stable versions are always enabled. Unstable and experimental versions
58	/// are included only when their respective configuration flags permit
59	/// them.
60	pub fn supported_room_version(&self, version: &RoomVersionId) -> bool {
61		self.supported_room_versions()
62			.any(|(supported_version, _)| &supported_version == version)
63	}
64
65	#[inline]
66	/// Iterates over the room versions enabled by this configuration.
67	///
68	/// Stable versions appear first, followed by permitted unstable and
69	/// experimental versions. Experimental entries are advertised as unstable.
70	pub fn supported_room_versions(
71		&self,
72	) -> impl Iterator<Item = (RoomVersionId, RoomVersionStability)> + '_ {
73		let stable_room_versions = STABLE_ROOM_VERSIONS
74			.iter()
75			.cloned()
76			.map(|version| (version, RoomVersionStability::Stable));
77
78		let unstable_room_versions = UNSTABLE_ROOM_VERSIONS
79			.iter()
80			.filter(|_| self.rooms.allow_unstable_versions)
81			.cloned()
82			.map(|version| (version, RoomVersionStability::Unstable));
83
84		let experimental_room_versions = EXPERIMENTAL_ROOM_VERSIONS
85			.iter()
86			.filter(|_| self.rooms.allow_experimental_versions)
87			.cloned()
88			.map(|version| (version, RoomVersionStability::Unstable));
89
90		stable_room_versions
91			.chain(unstable_room_versions)
92			.chain(experimental_room_versions)
93	}
94}