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 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
//! `POST /_matrix/client/*/search`
//!
//! Search events.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3search
use std::collections::BTreeMap;
use js_int::{uint, UInt};
use ruma_common::{
api::{request, response, Metadata},
metadata,
serde::{Raw, StringEnum},
OwnedEventId, OwnedMxcUri, OwnedRoomId, OwnedUserId,
};
use ruma_events::{AnyStateEvent, AnyTimelineEvent};
use serde::{Deserialize, Serialize};
use crate::{filter::RoomEventFilter, PrivOwnedStr};
const METADATA: Metadata = metadata! {
method: POST,
rate_limited: true,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/search",
1.1 => "/_matrix/client/v3/search",
}
};
/// Request type for the `search` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The point to return events from.
///
/// If given, this should be a `next_batch` result from a previous call to this endpoint.
#[ruma_api(query)]
pub next_batch: Option<String>,
/// Describes which categories to search in and their criteria.
pub search_categories: Categories,
}
/// Response type for the `search` endpoint.
#[response(error = crate::Error)]
pub struct Response {
/// A grouping of search results by category.
pub search_categories: ResultCategories,
}
impl Request {
/// Creates a new `Request` with the given categories.
pub fn new(search_categories: Categories) -> Self {
Self { next_batch: None, search_categories }
}
}
impl Response {
/// Creates a new `Response` with the given search results.
pub fn new(search_categories: ResultCategories) -> Self {
Self { search_categories }
}
}
/// Categories of events that can be searched for.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct Categories {
/// Criteria for searching room events.
#[serde(skip_serializing_if = "Option::is_none")]
pub room_events: Option<Criteria>,
}
impl Categories {
/// Creates an empty `Categories`.
pub fn new() -> Self {
Default::default()
}
}
/// Criteria for searching a category of events.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct Criteria {
/// The string to search events for.
pub search_term: String,
/// The keys to search for.
///
/// Defaults to all keys.
#[serde(skip_serializing_if = "Option::is_none")]
pub keys: Option<Vec<SearchKeys>>,
/// A `Filter` to apply to the search.
#[serde(skip_serializing_if = "RoomEventFilter::is_empty")]
pub filter: RoomEventFilter,
/// The order in which to search for results.
#[serde(skip_serializing_if = "Option::is_none")]
pub order_by: Option<OrderBy>,
/// Configures whether any context for the events returned are included in the response.
#[serde(default, skip_serializing_if = "EventContext::is_default")]
pub event_context: EventContext,
/// Requests the server return the current state for each room returned.
#[serde(skip_serializing_if = "Option::is_none")]
pub include_state: Option<bool>,
/// Requests that the server partitions the result set based on the provided list of keys.
#[serde(default, skip_serializing_if = "Groupings::is_empty")]
pub groupings: Groupings,
}
impl Criteria {
/// Creates a new `Criteria` with the given search term.
pub fn new(search_term: String) -> Self {
Self {
search_term,
keys: None,
filter: RoomEventFilter::default(),
order_by: None,
event_context: Default::default(),
include_state: None,
groupings: Default::default(),
}
}
}
/// Configures whether any context for the events returned are included in the response.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct EventContext {
/// How many events before the result are returned.
#[serde(
default = "default_event_context_limit",
skip_serializing_if = "is_default_event_context_limit"
)]
pub before_limit: UInt,
/// How many events after the result are returned.
#[serde(
default = "default_event_context_limit",
skip_serializing_if = "is_default_event_context_limit"
)]
pub after_limit: UInt,
/// Requests that the server returns the historic profile information for the users that
/// sent the events that were returned.
#[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
pub include_profile: bool,
}
fn default_event_context_limit() -> UInt {
uint!(5)
}
#[allow(clippy::trivially_copy_pass_by_ref)]
fn is_default_event_context_limit(val: &UInt) -> bool {
*val == default_event_context_limit()
}
impl EventContext {
/// Creates an `EventContext` with all-default values.
pub fn new() -> Self {
Self {
before_limit: default_event_context_limit(),
after_limit: default_event_context_limit(),
include_profile: false,
}
}
/// Returns whether all fields have their default value.
pub fn is_default(&self) -> bool {
self.before_limit == default_event_context_limit()
&& self.after_limit == default_event_context_limit()
&& !self.include_profile
}
}
impl Default for EventContext {
fn default() -> Self {
Self::new()
}
}
/// Context for search results, if requested.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct EventContextResult {
/// Pagination token for the end of the chunk.
#[serde(skip_serializing_if = "Option::is_none")]
pub end: Option<String>,
/// Events just after the result.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub events_after: Vec<Raw<AnyTimelineEvent>>,
/// Events just before the result.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub events_before: Vec<Raw<AnyTimelineEvent>>,
/// The historic profile information of the users that sent the events returned.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub profile_info: BTreeMap<OwnedUserId, UserProfile>,
/// Pagination token for the start of the chunk.
#[serde(skip_serializing_if = "Option::is_none")]
pub start: Option<String>,
}
impl EventContextResult {
/// Creates an empty `EventContextResult`.
pub fn new() -> Self {
Default::default()
}
/// Returns whether all fields are `None` or an empty list.
pub fn is_empty(&self) -> bool {
self.end.is_none()
&& self.events_after.is_empty()
&& self.events_before.is_empty()
&& self.profile_info.is_empty()
&& self.start.is_none()
}
}
/// A grouping for partitioning the result set.
#[derive(Clone, Default, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct Grouping {
/// The key within events to use for this grouping.
pub key: Option<GroupingKey>,
}
impl Grouping {
/// Creates an empty `Grouping`.
pub fn new() -> Self {
Default::default()
}
/// Returns whether `key` is `None`.
pub fn is_empty(&self) -> bool {
self.key.is_none()
}
}
/// The key within events to use for this grouping.
#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, StringEnum)]
#[ruma_enum(rename_all = "snake_case")]
#[non_exhaustive]
pub enum GroupingKey {
/// `room_id`
RoomId,
/// `sender`
Sender,
#[doc(hidden)]
_Custom(PrivOwnedStr),
}
/// Requests that the server partitions the result set based on the provided list of keys.
#[derive(Clone, Default, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct Groupings {
/// List of groups to request.
#[serde(default, skip_serializing_if = "<[_]>::is_empty")]
pub group_by: Vec<Grouping>,
}
impl Groupings {
/// Creates an empty `Groupings`.
pub fn new() -> Self {
Default::default()
}
/// Returns `true` if all fields are empty.
pub fn is_empty(&self) -> bool {
self.group_by.is_empty()
}
}
/// The keys to search for.
#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
#[derive(Clone, PartialEq, Eq, StringEnum)]
#[non_exhaustive]
pub enum SearchKeys {
/// content.body
#[ruma_enum(rename = "content.body")]
ContentBody,
/// content.name
#[ruma_enum(rename = "content.name")]
ContentName,
/// content.topic
#[ruma_enum(rename = "content.topic")]
ContentTopic,
#[doc(hidden)]
_Custom(PrivOwnedStr),
}
/// The order in which to search for results.
#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
#[derive(Clone, PartialEq, Eq, StringEnum)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
#[ruma_enum(rename_all = "snake_case")]
pub enum OrderBy {
/// Prioritize recent events.
Recent,
/// Prioritize events by a numerical ranking of how closely they matched the search
/// criteria.
Rank,
#[doc(hidden)]
_Custom(PrivOwnedStr),
}
/// Categories of events that can be searched for.
#[derive(Clone, Default, Debug, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct ResultCategories {
/// Room event results.
#[serde(default, skip_serializing_if = "ResultRoomEvents::is_empty")]
pub room_events: ResultRoomEvents,
}
impl ResultCategories {
/// Creates an empty `ResultCategories`.
pub fn new() -> Self {
Default::default()
}
}
/// Categories of events that can be searched for.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct ResultRoomEvents {
/// An approximate count of the total number of results found.
#[serde(skip_serializing_if = "Option::is_none")]
pub count: Option<UInt>,
/// Any groups that were requested.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub groups: BTreeMap<GroupingKey, BTreeMap<OwnedRoomIdOrUserId, ResultGroup>>,
/// Token that can be used to get the next batch of results, by passing as the `next_batch`
/// parameter to the next call.
///
/// If this field is absent, there are no more results.
#[serde(skip_serializing_if = "Option::is_none")]
pub next_batch: Option<String>,
/// List of results in the requested order.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub results: Vec<SearchResult>,
/// The current state for every room in the results.
///
/// This is included if the request had the `include_state` key set with a value of `true`.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub state: BTreeMap<OwnedRoomId, Vec<Raw<AnyStateEvent>>>,
/// List of words which should be highlighted, useful for stemming which may
/// change the query terms.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub highlights: Vec<String>,
}
impl ResultRoomEvents {
/// Creates an empty `ResultRoomEvents`.
pub fn new() -> Self {
Default::default()
}
/// Returns `true` if all fields are empty / `None`.
pub fn is_empty(&self) -> bool {
self.count.is_none()
&& self.groups.is_empty()
&& self.next_batch.is_none()
&& self.results.is_empty()
&& self.state.is_empty()
&& self.highlights.is_empty()
}
}
/// A grouping of results, if requested.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct ResultGroup {
/// Token that can be used to get the next batch of results in the group, by passing as the
/// `next_batch` parameter to the next call.
///
/// If this field is absent, there are no more results in this group.
#[serde(skip_serializing_if = "Option::is_none")]
pub next_batch: Option<String>,
/// Key that can be used to order different groups.
#[serde(skip_serializing_if = "Option::is_none")]
pub order: Option<UInt>,
/// Which results are in this group.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub results: Vec<OwnedEventId>,
}
impl ResultGroup {
/// Creates an empty `ResultGroup`.
pub fn new() -> Self {
Default::default()
}
/// Returns `true` if all fields are empty / `None`.
pub fn is_empty(&self) -> bool {
self.next_batch.is_none() && self.order.is_none() && self.results.is_empty()
}
}
/// A search result.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct SearchResult {
/// Context for result, if requested.
#[serde(skip_serializing_if = "EventContextResult::is_empty")]
pub context: EventContextResult,
/// A number that describes how closely this result matches the search.
///
/// Higher is closer.
#[serde(skip_serializing_if = "Option::is_none")]
pub rank: Option<f64>,
/// The event that matched.
#[serde(skip_serializing_if = "Option::is_none")]
pub result: Option<Raw<AnyTimelineEvent>>,
}
impl SearchResult {
/// Creates an empty `SearchResult`.
pub fn new() -> Self {
Default::default()
}
/// Returns `true` if all fields are empty / `None`.
pub fn is_empty(&self) -> bool {
self.context.is_empty() && self.rank.is_none() && self.result.is_none()
}
}
/// A user profile.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
pub struct UserProfile {
/// The user's avatar URL, if set.
///
/// If you activate the `compat-empty-string-null` feature, this field being an empty
/// string in JSON will result in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat-empty-string-null",
serde(default, deserialize_with = "ruma_common::serde::empty_string_as_none")
)]
pub avatar_url: Option<OwnedMxcUri>,
/// The user's display name, if set.
#[serde(skip_serializing_if = "Option::is_none")]
pub displayname: Option<String>,
}
impl UserProfile {
/// Creates an empty `UserProfile`.
pub fn new() -> Self {
Default::default()
}
/// Returns `true` if all fields are `None`.
pub fn is_empty(&self) -> bool {
self.avatar_url.is_none() && self.displayname.is_none()
}
}
/// Represents either a room or user ID for returning grouped search results.
#[derive(Clone, Debug, Deserialize, Eq, Ord, PartialEq, PartialOrd, Serialize)]
#[allow(clippy::exhaustive_enums)]
pub enum OwnedRoomIdOrUserId {
/// Represents a room ID.
RoomId(OwnedRoomId),
/// Represents a user ID.
UserId(OwnedUserId),
}
}