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 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
//! Endpoints for event filters.
pub mod create_filter;
pub mod get_filter;
mod lazy_load;
mod url;
use js_int::UInt;
use ruma_common::{serde::StringEnum, OwnedRoomId, OwnedUserId};
use serde::{Deserialize, Serialize};
pub use self::{lazy_load::LazyLoadOptions, url::UrlFilter};
use crate::PrivOwnedStr;
/// Format to use for returned events.
#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
#[derive(Clone, Default, PartialEq, Eq, StringEnum)]
#[ruma_enum(rename_all = "snake_case")]
#[non_exhaustive]
pub enum EventFormat {
/// Client format, as described in the Client API.
#[default]
Client,
/// Raw events from federation.
Federation,
#[doc(hidden)]
_Custom(PrivOwnedStr),
}
/// Filters to be applied to room events.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct RoomEventFilter {
/// A list of event types to exclude.
///
/// If this list is absent then no event types are excluded. A matching type will be excluded
/// even if it is listed in the 'types' filter. A '*' can be used as a wildcard to match any
/// sequence of characters.
#[serde(default, skip_serializing_if = "<[_]>::is_empty")]
pub not_types: Vec<String>,
/// A list of room IDs to exclude.
///
/// If this list is absent then no rooms are excluded. A matching room will be excluded even if
/// it is listed in the 'rooms' filter.
#[serde(default, skip_serializing_if = "<[_]>::is_empty")]
pub not_rooms: Vec<OwnedRoomId>,
/// The maximum number of events to return.
#[serde(skip_serializing_if = "Option::is_none")]
pub limit: Option<UInt>,
/// A list of room IDs to include.
///
/// If this list is absent then all rooms are included.
#[serde(skip_serializing_if = "Option::is_none")]
pub rooms: Option<Vec<OwnedRoomId>>,
/// A list of sender IDs to exclude.
///
/// If this list is absent then no senders are excluded. A matching sender will be excluded
/// even if it is listed in the 'senders' filter.
#[serde(default, skip_serializing_if = "<[_]>::is_empty")]
pub not_senders: Vec<OwnedUserId>,
/// A list of senders IDs to include.
///
/// If this list is absent then all senders are included.
#[serde(skip_serializing_if = "Option::is_none")]
pub senders: Option<Vec<OwnedUserId>>,
/// A list of event types to include.
///
/// If this list is absent then all event types are included. A '*' can be used as a wildcard
/// to match any sequence of characters.
#[serde(skip_serializing_if = "Option::is_none")]
pub types: Option<Vec<String>>,
/// Controls whether to include events with a URL key in their content.
///
/// * `None`: No filtering
/// * `Some(EventsWithUrl)`: Only events with a URL
/// * `Some(EventsWithoutUrl)`: Only events without a URL
#[serde(rename = "contains_url", skip_serializing_if = "Option::is_none")]
pub url_filter: Option<UrlFilter>,
/// Options to control lazy-loading of membership events.
///
/// Defaults to `LazyLoadOptions::Disabled`.
#[serde(flatten)]
pub lazy_load_options: LazyLoadOptions,
/// Whether to enable [per-thread notification counts].
///
/// Only applies to the [`sync_events`] endpoint.
///
/// [per-thread notification counts]: https://spec.matrix.org/latest/client-server-api/#receiving-notifications
/// [`sync_events`]: crate::sync::sync_events
#[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
pub unread_thread_notifications: bool,
}
impl RoomEventFilter {
/// Creates an empty `RoomEventFilter`.
///
/// You can also use the [`Default`] implementation.
pub fn empty() -> Self {
Self::default()
}
/// Creates a new `RoomEventFilter` that can be used to ignore all room events.
pub fn ignore_all() -> Self {
Self { types: Some(vec![]), ..Default::default() }
}
/// Creates a new `RoomEventFilter` with [room member lazy-loading] enabled.
///
/// Redundant membership events are disabled.
///
/// [room member lazy-loading]: https://spec.matrix.org/latest/client-server-api/#lazy-loading-room-members
pub fn with_lazy_loading() -> Self {
Self {
lazy_load_options: LazyLoadOptions::Enabled { include_redundant_members: false },
..Default::default()
}
}
/// Returns `true` if all fields are empty.
pub fn is_empty(&self) -> bool {
self.not_types.is_empty()
&& self.not_rooms.is_empty()
&& self.limit.is_none()
&& self.rooms.is_none()
&& self.not_senders.is_empty()
&& self.senders.is_none()
&& self.types.is_none()
&& self.url_filter.is_none()
&& self.lazy_load_options.is_disabled()
&& !self.unread_thread_notifications
}
}
/// Filters to be applied to room data.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct RoomFilter {
/// Include rooms that the user has left in the sync.
///
/// Defaults to `false`.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
pub include_leave: bool,
/// The per user account data to include for rooms.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_empty")]
pub account_data: RoomEventFilter,
/// The message and state update events to include for rooms.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_empty")]
pub timeline: RoomEventFilter,
/// The events that aren't recorded in the room history, e.g. typing and receipts, to include
/// for rooms.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_empty")]
pub ephemeral: RoomEventFilter,
/// The state events to include for rooms.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_empty")]
pub state: RoomEventFilter,
/// A list of room IDs to exclude.
///
/// If this list is absent then no rooms are excluded. A matching room will be excluded even if
/// it is listed in the 'rooms' filter. This filter is applied before the filters in
/// `ephemeral`, `state`, `timeline` or `account_data`.
#[serde(default, skip_serializing_if = "<[_]>::is_empty")]
pub not_rooms: Vec<OwnedRoomId>,
/// A list of room IDs to include.
///
/// If this list is absent then all rooms are included. This filter is applied before the
/// filters in `ephemeral`, `state`, `timeline` or `account_data`.
#[serde(skip_serializing_if = "Option::is_none")]
pub rooms: Option<Vec<OwnedRoomId>>,
}
impl RoomFilter {
/// Creates an empty `RoomFilter`.
///
/// You can also use the [`Default`] implementation.
pub fn empty() -> Self {
Self::default()
}
/// Creates a new `RoomFilter` that can be used to ignore all room events (of any type).
pub fn ignore_all() -> Self {
Self { rooms: Some(vec![]), ..Default::default() }
}
/// Creates a new `RoomFilter` with [room member lazy-loading] enabled.
///
/// Redundant membership events are disabled.
///
/// [room member lazy-loading]: https://spec.matrix.org/latest/client-server-api/#lazy-loading-room-members
pub fn with_lazy_loading() -> Self {
Self { state: RoomEventFilter::with_lazy_loading(), ..Default::default() }
}
/// Returns `true` if all fields are empty.
pub fn is_empty(&self) -> bool {
!self.include_leave
&& self.account_data.is_empty()
&& self.timeline.is_empty()
&& self.ephemeral.is_empty()
&& self.state.is_empty()
&& self.not_rooms.is_empty()
&& self.rooms.is_none()
}
}
/// Filter for non-room data.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct Filter {
/// A list of event types to exclude.
///
/// If this list is absent then no event types are excluded. A matching type will be excluded
/// even if it is listed in the 'types' filter. A '*' can be used as a wildcard to match any
/// sequence of characters.
#[serde(default, skip_serializing_if = "<[_]>::is_empty")]
pub not_types: Vec<String>,
/// The maximum number of events to return.
#[serde(skip_serializing_if = "Option::is_none")]
pub limit: Option<UInt>,
/// A list of senders IDs to include.
///
/// If this list is absent then all senders are included.
#[serde(skip_serializing_if = "Option::is_none")]
pub senders: Option<Vec<OwnedUserId>>,
/// A list of event types to include.
///
/// If this list is absent then all event types are included. A '*' can be used as a wildcard
/// to match any sequence of characters.
#[serde(skip_serializing_if = "Option::is_none")]
pub types: Option<Vec<String>>,
/// A list of sender IDs to exclude.
///
/// If this list is absent then no senders are excluded. A matching sender will be excluded
/// even if it is listed in the 'senders' filter.
#[serde(default, skip_serializing_if = "<[_]>::is_empty")]
pub not_senders: Vec<OwnedUserId>,
}
impl Filter {
/// Creates an empty `Filter`.
///
/// You can also use the [`Default`] implementation.
pub fn empty() -> Self {
Self::default()
}
/// Creates a new `Filter` that can be used to ignore all events.
pub fn ignore_all() -> Self {
Self { types: Some(vec![]), ..Default::default() }
}
/// Returns `true` if all fields are empty.
pub fn is_empty(&self) -> bool {
self.not_types.is_empty()
&& self.limit.is_none()
&& self.senders.is_none()
&& self.types.is_none()
&& self.not_senders.is_empty()
}
}
/// A filter definition
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct FilterDefinition {
/// List of event fields to include.
///
/// If this list is absent then all fields are included. The entries may include '.' characters
/// to indicate sub-fields. So ['content.body'] will include the 'body' field of the 'content'
/// object. A literal '.' or '\' character in a field name may be escaped using a '\'. A server
/// may include more fields than were requested.
#[serde(skip_serializing_if = "Option::is_none")]
pub event_fields: Option<Vec<String>>,
/// The format to use for events.
///
/// 'client' will return the events in a format suitable for clients. 'federation' will return
/// the raw event as received over federation. The default is 'client'.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
pub event_format: EventFormat,
/// The presence updates to include.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_empty")]
pub presence: Filter,
/// The user account data that isn't associated with rooms to include.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_empty")]
pub account_data: Filter,
/// Filters to be applied to room data.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_empty")]
pub room: RoomFilter,
}
impl FilterDefinition {
/// Creates an empty `FilterDefinition`.
///
/// You can also use the [`Default`] implementation.
pub fn empty() -> Self {
Self::default()
}
/// Creates a new `FilterDefinition` that can be used to ignore all events.
pub fn ignore_all() -> Self {
Self {
account_data: Filter::ignore_all(),
room: RoomFilter::ignore_all(),
presence: Filter::ignore_all(),
..Default::default()
}
}
/// Creates a new `FilterDefinition` with [room member lazy-loading] enabled.
///
/// Redundant membership events are disabled.
///
/// [room member lazy-loading]: https://spec.matrix.org/latest/client-server-api/#lazy-loading-room-members
pub fn with_lazy_loading() -> Self {
Self { room: RoomFilter::with_lazy_loading(), ..Default::default() }
}
/// Returns `true` if all fields are empty.
pub fn is_empty(&self) -> bool {
self.event_fields.is_none()
&& self.event_format == EventFormat::Client
&& self.presence.is_empty()
&& self.account_data.is_empty()
&& self.room.is_empty()
}
}
macro_rules! can_be_empty {
($ty:ident) => {
impl ruma_common::serde::CanBeEmpty for $ty {
fn is_empty(&self) -> bool {
self.is_empty()
}
}
};
}
can_be_empty!(Filter);
can_be_empty!(FilterDefinition);
can_be_empty!(RoomEventFilter);
can_be_empty!(RoomFilter);
#[cfg(test)]
mod tests {
use serde_json::{from_value as from_json_value, json, to_value as to_json_value};
use super::{
Filter, FilterDefinition, LazyLoadOptions, RoomEventFilter, RoomFilter, UrlFilter,
};
#[test]
fn default_filters_are_empty() -> serde_json::Result<()> {
assert_eq!(to_json_value(Filter::default())?, json!({}));
assert_eq!(to_json_value(FilterDefinition::default())?, json!({}));
assert_eq!(to_json_value(RoomEventFilter::default())?, json!({}));
assert_eq!(to_json_value(RoomFilter::default())?, json!({}));
Ok(())
}
#[test]
fn filter_definition_roundtrip() -> serde_json::Result<()> {
let filter = FilterDefinition::default();
let filter_str = to_json_value(&filter)?;
let incoming_filter = from_json_value::<FilterDefinition>(filter_str)?;
assert!(incoming_filter.is_empty());
Ok(())
}
#[test]
fn room_filter_definition_roundtrip() -> serde_json::Result<()> {
let filter = RoomFilter::default();
let room_filter = to_json_value(filter)?;
let incoming_room_filter = from_json_value::<RoomFilter>(room_filter)?;
assert!(incoming_room_filter.is_empty());
Ok(())
}
#[test]
fn issue_366() {
let obj = json!({
"lazy_load_members": true,
"filter_json": { "contains_url": true, "types": ["m.room.message"] },
"types": ["m.room.message"],
"not_types": [],
"rooms": null,
"not_rooms": [],
"senders": null,
"not_senders": [],
"contains_url": true,
});
let filter: RoomEventFilter = from_json_value(obj).unwrap();
assert_eq!(filter.types, Some(vec!["m.room.message".to_owned()]));
assert_eq!(filter.not_types, vec![""; 0]);
assert_eq!(filter.rooms, None);
assert_eq!(filter.not_rooms, vec![""; 0]);
assert_eq!(filter.senders, None);
assert_eq!(filter.not_senders, vec![""; 0]);
assert_eq!(filter.limit, None);
assert_eq!(filter.url_filter, Some(UrlFilter::EventsWithUrl));
assert_eq!(
filter.lazy_load_options,
LazyLoadOptions::Enabled { include_redundant_members: false }
);
}
}