550 lines
18 KiB
Rust
550 lines
18 KiB
Rust
use matrix_sdk_common::{
|
|
api::r0::{
|
|
account::register::{self, RegistrationKind},
|
|
directory::get_public_rooms_filtered,
|
|
filter::RoomEventFilter,
|
|
membership::Invite3pid,
|
|
message::get_message_events::{self, Direction},
|
|
room::{
|
|
create_room::{self, CreationContent, InitialStateEvent, RoomPreset},
|
|
Visibility,
|
|
},
|
|
uiaa::AuthData,
|
|
},
|
|
directory::{Filter, RoomNetwork},
|
|
events::room::{create::PreviousRoom, power_levels::PowerLevelsEventContent},
|
|
identifiers::{DeviceId, RoomId, UserId},
|
|
js_int::UInt,
|
|
};
|
|
|
|
/// A builder used to create rooms.
|
|
///
|
|
/// # Examples
|
|
/// ```
|
|
/// # use std::convert::TryFrom;
|
|
/// # use matrix_sdk::{Client, RoomBuilder};
|
|
/// # use matrix_sdk::api::r0::room::Visibility;
|
|
/// # use matrix_sdk::identifiers::UserId;
|
|
/// # use url::Url;
|
|
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
|
/// # let mut rt = tokio::runtime::Runtime::new().unwrap();
|
|
/// # rt.block_on(async {
|
|
/// let mut builder = RoomBuilder::new();
|
|
/// builder.federate(false)
|
|
/// .initial_state(vec![])
|
|
/// .visibility(Visibility::Public)
|
|
/// .name("name")
|
|
/// .room_version("v1.0");
|
|
/// let mut client = Client::new(homeserver).unwrap();
|
|
/// client.create_room(builder).await;
|
|
/// # })
|
|
/// ```
|
|
#[derive(Clone, Debug)]
|
|
pub struct RoomBuilder {
|
|
req: create_room::Request,
|
|
creation_content: CreationContent,
|
|
}
|
|
|
|
impl RoomBuilder {
|
|
/// Returns an empty `RoomBuilder` for creating rooms.
|
|
pub fn new() -> Self {
|
|
Self {
|
|
req: create_room::Request::new(),
|
|
creation_content: CreationContent {
|
|
federate: true,
|
|
predecessor: None,
|
|
},
|
|
}
|
|
}
|
|
|
|
/// A reference to the room this room replaces, if the previous room was upgraded.
|
|
///
|
|
/// Note: this is used to create the `CreationContent`.
|
|
pub fn previous_room(&mut self, previous_room: PreviousRoom) -> &mut Self {
|
|
self.creation_content.predecessor = Some(previous_room);
|
|
self
|
|
}
|
|
|
|
/// Whether users on other servers can join this room.
|
|
///
|
|
/// Defaults to `true` if key does not exist.
|
|
/// Note: this is used to create the `CreationContent`.
|
|
pub fn federate(&mut self, federate: bool) -> &mut Self {
|
|
self.creation_content.federate = federate;
|
|
self
|
|
}
|
|
|
|
/// Sets a list of state events to send to the new room.
|
|
///
|
|
/// Takes precedence over events set by preset, but gets overriden by
|
|
/// name and topic keys.
|
|
pub fn initial_state(&mut self, state: Vec<InitialStateEvent>) -> &mut Self {
|
|
self.req.initial_state = state;
|
|
self
|
|
}
|
|
|
|
/// Sets a list of user IDs to invite to the room.
|
|
///
|
|
/// This will tell the server to invite everyone in the list to the newly created room.
|
|
pub fn invite(&mut self, invite: Vec<UserId>) -> &mut Self {
|
|
self.req.invite = invite;
|
|
self
|
|
}
|
|
|
|
/// Sets a list of third party IDs of users to invite.
|
|
pub fn invite_3pid(&mut self, invite: Vec<Invite3pid>) -> &mut Self {
|
|
self.req.invite_3pid = invite;
|
|
self
|
|
}
|
|
|
|
/// If set, this sets the `is_direct` flag on room invites.
|
|
pub fn is_direct(&mut self, direct: bool) -> &mut Self {
|
|
self.req.is_direct = Some(direct);
|
|
self
|
|
}
|
|
|
|
/// If this is included, an `m.room.name` event will be sent into the room to indicate
|
|
/// the name of the room.
|
|
pub fn name<S: Into<String>>(&mut self, name: S) -> &mut Self {
|
|
self.req.name = Some(name.into());
|
|
self
|
|
}
|
|
|
|
/// Power level content to override in the default power level event.
|
|
pub fn power_level_override(&mut self, power: PowerLevelsEventContent) -> &mut Self {
|
|
self.req.power_level_content_override = Some(power.into());
|
|
self
|
|
}
|
|
|
|
/// Convenience parameter for setting various default state events based on a preset.
|
|
pub fn preset(&mut self, preset: RoomPreset) -> &mut Self {
|
|
self.req.preset = Some(preset);
|
|
self
|
|
}
|
|
|
|
/// The desired room alias local part.
|
|
pub fn room_alias_name<S: Into<String>>(&mut self, alias: S) -> &mut Self {
|
|
self.req.room_alias_name = Some(alias.into());
|
|
self
|
|
}
|
|
|
|
/// Room version to set for the room. Defaults to homeserver's default if not specified.
|
|
pub fn room_version<S: Into<String>>(&mut self, version: S) -> &mut Self {
|
|
self.req.room_version = Some(version.into());
|
|
self
|
|
}
|
|
|
|
/// If this is included, an `m.room.topic` event will be sent into the room to indicate
|
|
/// the topic for the room.
|
|
pub fn topic<S: Into<String>>(&mut self, topic: S) -> &mut Self {
|
|
self.req.topic = Some(topic.into());
|
|
self
|
|
}
|
|
|
|
/// A public visibility indicates that the room will be shown in the published
|
|
/// room list. A private visibility will hide the room from the published room list.
|
|
/// Rooms default to private visibility if this key is not included.
|
|
pub fn visibility(&mut self, vis: Visibility) -> &mut Self {
|
|
self.req.visibility = Some(vis);
|
|
self
|
|
}
|
|
}
|
|
|
|
impl Default for RoomBuilder {
|
|
fn default() -> Self {
|
|
Self::new()
|
|
}
|
|
}
|
|
|
|
impl Into<create_room::Request> for RoomBuilder {
|
|
fn into(mut self) -> create_room::Request {
|
|
self.req.creation_content = Some(self.creation_content);
|
|
self.req
|
|
}
|
|
}
|
|
|
|
/// Create a builder for making get_message_event requests.
|
|
///
|
|
/// # Examples
|
|
/// ```
|
|
/// # use std::convert::TryFrom;
|
|
/// # use matrix_sdk::{Client, MessagesRequestBuilder};
|
|
/// # use matrix_sdk::api::r0::message::get_message_events::{self, Direction};
|
|
/// # use matrix_sdk::identifiers::room_id;
|
|
/// # use url::Url;
|
|
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
|
/// # let mut rt = tokio::runtime::Runtime::new().unwrap();
|
|
/// # rt.block_on(async {
|
|
/// # let room_id = room_id!("!test:localhost");
|
|
/// # let last_sync_token = "".to_string();
|
|
/// let mut client = Client::new(homeserver).unwrap();
|
|
///
|
|
/// let room_id = room_id!("!roomid:example.com");
|
|
/// let mut builder = MessagesRequestBuilder::new(&room_id, "t47429-4392820_219380_26003_2265");
|
|
///
|
|
/// builder.to("t4357353_219380_26003_2265")
|
|
/// .direction(Direction::Backward)
|
|
/// .limit(10);
|
|
///
|
|
/// client.room_messages(builder).await.is_err();
|
|
/// # })
|
|
/// ```
|
|
#[derive(Clone, Debug)]
|
|
pub struct MessagesRequestBuilder<'a>(get_message_events::Request<'a>);
|
|
|
|
impl<'a> MessagesRequestBuilder<'a> {
|
|
/// Create a `MessagesRequestBuilder` builder to make a `get_message_events::Request`.
|
|
///
|
|
/// # Arguments
|
|
///
|
|
/// * `room_id` - The id of the room that is being requested.
|
|
///
|
|
/// * `from` - The token to start returning events from. This token can be obtained from
|
|
/// a `prev_batch` token from a sync response, or a start or end token from a previous request
|
|
/// to this endpoint.
|
|
pub fn new(room_id: &'a RoomId, from: &'a str) -> Self {
|
|
Self(get_message_events::Request::new(
|
|
room_id,
|
|
from,
|
|
Direction::Backward,
|
|
))
|
|
}
|
|
|
|
/// A `next_batch` token or `start` or `end` from a previous `get_message_events` request.
|
|
///
|
|
/// This token signals when to stop receiving events.
|
|
pub fn to(&mut self, to: &'a str) -> &mut Self {
|
|
self.0.to = Some(to);
|
|
self
|
|
}
|
|
|
|
/// The direction to return events from.
|
|
///
|
|
/// If not specified `Direction::Backward` is used.
|
|
pub fn direction(&mut self, direction: Direction) -> &mut Self {
|
|
self.0.dir = direction;
|
|
self
|
|
}
|
|
|
|
/// The maximum number of events to return.
|
|
///
|
|
/// The default is 10.
|
|
pub fn limit(&mut self, limit: u32) -> &mut Self {
|
|
self.0.limit = UInt::from(limit);
|
|
self
|
|
}
|
|
|
|
/// Filter events by the given `RoomEventFilter`.
|
|
pub fn filter(&mut self, filter: RoomEventFilter) -> &mut Self {
|
|
self.0.filter = Some(filter);
|
|
self
|
|
}
|
|
}
|
|
|
|
impl<'a> Into<get_message_events::Request<'a>> for MessagesRequestBuilder<'a> {
|
|
fn into(self) -> get_message_events::Request<'a> {
|
|
self.0
|
|
}
|
|
}
|
|
|
|
/// A builder used to register users.
|
|
///
|
|
/// # Examples
|
|
/// ```
|
|
/// # use std::convert::TryFrom;
|
|
/// # use matrix_sdk::{Client, RegistrationBuilder};
|
|
/// # use matrix_sdk::api::r0::account::register::RegistrationKind;
|
|
/// # use matrix_sdk::identifiers::DeviceId;
|
|
/// # use url::Url;
|
|
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
|
/// # let mut rt = tokio::runtime::Runtime::new().unwrap();
|
|
/// # rt.block_on(async {
|
|
/// let mut builder = RegistrationBuilder::default();
|
|
/// builder.password("pass")
|
|
/// .username("user")
|
|
/// .kind(RegistrationKind::User);
|
|
/// let mut client = Client::new(homeserver).unwrap();
|
|
/// client.register_user(builder).await;
|
|
/// # })
|
|
/// ```
|
|
#[derive(Clone, Debug, Default)]
|
|
pub struct RegistrationBuilder<'a> {
|
|
password: Option<&'a str>,
|
|
username: Option<&'a str>,
|
|
device_id: Option<&'a DeviceId>,
|
|
initial_device_display_name: Option<&'a str>,
|
|
auth: Option<AuthData<'a>>,
|
|
kind: Option<RegistrationKind>,
|
|
inhibit_login: bool,
|
|
}
|
|
|
|
impl<'a> RegistrationBuilder<'a> {
|
|
/// Create a `RegistrationBuilder` builder to make a `register::Request`.
|
|
pub fn new() -> Self {
|
|
Self::default()
|
|
}
|
|
|
|
/// The desired password for the account.
|
|
///
|
|
/// May be empty for accounts that should not be able to log in again
|
|
/// with a password, e.g., for guest or application service accounts.
|
|
pub fn password(&mut self, password: &'a str) -> &mut Self {
|
|
self.password = Some(password);
|
|
self
|
|
}
|
|
|
|
/// local part of the desired Matrix ID.
|
|
///
|
|
/// If omitted, the homeserver MUST generate a Matrix ID local part.
|
|
pub fn username(&mut self, username: &'a str) -> &mut Self {
|
|
self.username = Some(username);
|
|
self
|
|
}
|
|
|
|
/// ID of the client device.
|
|
///
|
|
/// If this does not correspond to a known client device, a new device will be created.
|
|
/// The server will auto-generate a device_id if this is not specified.
|
|
pub fn device_id(&mut self, device_id: &'a DeviceId) -> &mut Self {
|
|
self.device_id = Some(device_id);
|
|
self
|
|
}
|
|
|
|
/// A display name to assign to the newly-created device.
|
|
///
|
|
/// Ignored if `device_id` corresponds to a known device.
|
|
pub fn initial_device_display_name(
|
|
&mut self,
|
|
initial_device_display_name: &'a str,
|
|
) -> &mut Self {
|
|
self.initial_device_display_name = Some(initial_device_display_name);
|
|
self
|
|
}
|
|
|
|
/// Additional authentication information for the user-interactive authentication API.
|
|
///
|
|
/// Note that this information is not used to define how the registered user should be
|
|
/// authenticated, but is instead used to authenticate the register call itself.
|
|
/// It should be left empty, or omitted, unless an earlier call returned an response
|
|
/// with status code 401.
|
|
pub fn auth(&mut self, auth: AuthData<'a>) -> &mut Self {
|
|
self.auth = Some(auth);
|
|
self
|
|
}
|
|
|
|
/// Kind of account to register
|
|
///
|
|
/// Defaults to `User` if omitted.
|
|
pub fn kind(&mut self, kind: RegistrationKind) -> &mut Self {
|
|
self.kind = Some(kind);
|
|
self
|
|
}
|
|
|
|
/// If `true`, an `access_token` and `device_id` should not be returned
|
|
/// from this call, therefore preventing an automatic login.
|
|
pub fn inhibit_login(&mut self, inhibit_login: bool) -> &mut Self {
|
|
self.inhibit_login = inhibit_login;
|
|
self
|
|
}
|
|
}
|
|
|
|
impl<'a> Into<register::Request<'a>> for RegistrationBuilder<'a> {
|
|
fn into(self) -> register::Request<'a> {
|
|
register::Request {
|
|
password: self.password,
|
|
username: self.username,
|
|
device_id: self.device_id,
|
|
initial_device_display_name: self.initial_device_display_name,
|
|
auth: self.auth,
|
|
kind: self.kind,
|
|
inhibit_login: self.inhibit_login,
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Create a builder for making get_public_rooms_filtered requests.
|
|
///
|
|
/// # Examples
|
|
/// ```
|
|
/// # use std::convert::TryFrom;
|
|
/// # use matrix_sdk::{Client, RoomListFilterBuilder};
|
|
/// # use matrix_sdk::directory::{Filter, RoomNetwork};
|
|
/// # use matrix_sdk::api::r0::directory::get_public_rooms_filtered;
|
|
/// # use url::Url;
|
|
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
|
/// # let mut rt = tokio::runtime::Runtime::new().unwrap();
|
|
/// # rt.block_on(async {
|
|
/// # let last_sync_token = "".to_string();
|
|
/// let mut client = Client::new(homeserver).unwrap();
|
|
///
|
|
/// let generic_search_term = Some("matrix-rust-sdk".to_string());
|
|
/// let mut builder = RoomListFilterBuilder::new();
|
|
/// builder
|
|
/// .filter(Filter { generic_search_term })
|
|
/// .since(&last_sync_token)
|
|
/// .room_network(RoomNetwork::Matrix);
|
|
///
|
|
/// client.public_rooms_filtered(builder).await.is_err();
|
|
/// # })
|
|
/// ```
|
|
#[derive(Clone, Debug, Default)]
|
|
pub struct RoomListFilterBuilder<'a> {
|
|
server: Option<&'a str>,
|
|
limit: Option<u32>,
|
|
since: Option<&'a str>,
|
|
filter: Option<Filter>,
|
|
room_network: Option<RoomNetwork>,
|
|
}
|
|
|
|
impl<'a> RoomListFilterBuilder<'a> {
|
|
/// Create a `RoomListFilterBuilder` builder to make a `get_message_events::Request`.
|
|
pub fn new() -> Self {
|
|
Self::default()
|
|
}
|
|
|
|
/// The server to fetch the public room lists from.
|
|
///
|
|
/// `None` means the server this request is sent to.
|
|
pub fn server(&mut self, server: &'a str) -> &mut Self {
|
|
self.server = Some(server);
|
|
self
|
|
}
|
|
|
|
/// Limit for the number of results to return.
|
|
pub fn limit(&mut self, limit: u32) -> &mut Self {
|
|
self.limit = Some(limit);
|
|
self
|
|
}
|
|
|
|
/// Pagination token from a previous request.
|
|
pub fn since(&mut self, since: &'a str) -> &mut Self {
|
|
self.since = Some(since);
|
|
self
|
|
}
|
|
|
|
/// Filter to apply to the results.
|
|
pub fn filter(&mut self, filter: Filter) -> &mut Self {
|
|
self.filter = Some(filter);
|
|
self
|
|
}
|
|
|
|
/// Network to fetch the public room lists from.
|
|
///
|
|
/// Defaults to the Matrix network.
|
|
pub fn room_network(&mut self, room_network: RoomNetwork) -> &mut Self {
|
|
self.room_network = Some(room_network);
|
|
self
|
|
}
|
|
}
|
|
|
|
impl<'a> Into<get_public_rooms_filtered::Request<'a>> for RoomListFilterBuilder<'a> {
|
|
fn into(self) -> get_public_rooms_filtered::Request<'a> {
|
|
get_public_rooms_filtered::Request {
|
|
room_network: self.room_network.unwrap_or_default(),
|
|
limit: self.limit.map(UInt::from),
|
|
server: self.server,
|
|
since: self.since,
|
|
filter: self.filter,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use std::collections::BTreeMap;
|
|
|
|
use super::*;
|
|
use crate::{
|
|
api::r0::filter::{LazyLoadOptions, RoomEventFilter},
|
|
events::room::power_levels::NotificationPowerLevels,
|
|
identifiers::{room_id, user_id},
|
|
js_int::Int,
|
|
Client, Session,
|
|
};
|
|
|
|
use matrix_sdk_test::test_json;
|
|
use mockito::{mock, Matcher};
|
|
use url::Url;
|
|
|
|
#[tokio::test]
|
|
async fn create_room_builder() {
|
|
let homeserver = Url::parse(&mockito::server_url()).unwrap();
|
|
|
|
let _m = mock("POST", "/_matrix/client/r0/createRoom")
|
|
.with_status(200)
|
|
.with_body(test_json::ROOM_ID.to_string())
|
|
.create();
|
|
|
|
let session = Session {
|
|
access_token: "1234".to_owned(),
|
|
user_id: user_id!("@example:localhost"),
|
|
device_id: "DEVICEID".into(),
|
|
};
|
|
|
|
let mut builder = RoomBuilder::new();
|
|
builder
|
|
.federate(false)
|
|
.initial_state(vec![])
|
|
.visibility(Visibility::Public)
|
|
.name("room_name")
|
|
.room_version("v1.0")
|
|
.invite_3pid(vec![])
|
|
.is_direct(true)
|
|
.power_level_override(PowerLevelsEventContent {
|
|
ban: Int::MAX,
|
|
events: BTreeMap::default(),
|
|
events_default: Int::MIN,
|
|
invite: Int::MIN,
|
|
kick: Int::MIN,
|
|
redact: Int::MAX,
|
|
state_default: Int::MIN,
|
|
users_default: Int::MIN,
|
|
notifications: NotificationPowerLevels { room: Int::MIN },
|
|
users: BTreeMap::default(),
|
|
})
|
|
.preset(RoomPreset::PrivateChat)
|
|
.room_alias_name("room_alias")
|
|
.topic("room topic")
|
|
.visibility(Visibility::Private);
|
|
let cli = Client::new(homeserver).unwrap();
|
|
cli.restore_login(session).await.unwrap();
|
|
assert!(cli.create_room(builder).await.is_ok());
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn get_message_events() {
|
|
let homeserver = Url::parse(&mockito::server_url()).unwrap();
|
|
|
|
let _m = mock(
|
|
"GET",
|
|
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/messages".to_string()),
|
|
)
|
|
.with_status(200)
|
|
.with_body(test_json::ROOM_MESSAGES.to_string())
|
|
.create();
|
|
|
|
let session = Session {
|
|
access_token: "1234".to_owned(),
|
|
user_id: user_id!("@example:localhost"),
|
|
device_id: "DEVICEID".into(),
|
|
};
|
|
|
|
let room_id = room_id!("!roomid:example.com");
|
|
let mut builder = MessagesRequestBuilder::new(&room_id, "t47429-4392820_219380_26003_2265");
|
|
builder
|
|
.to("t4357353_219380_26003_2265")
|
|
.direction(Direction::Backward)
|
|
.limit(10)
|
|
.filter(RoomEventFilter {
|
|
lazy_load_options: LazyLoadOptions::Enabled {
|
|
include_redundant_members: false,
|
|
},
|
|
..Default::default()
|
|
});
|
|
|
|
let cli = Client::new(homeserver).unwrap();
|
|
cli.restore_login(session).await.unwrap();
|
|
assert!(cli.room_messages(builder).await.is_ok());
|
|
}
|
|
}
|