7c34ac4e82
Use MxcUri instead of String for media URLs. Fix wrong MXC URIs in tests. Remove method parse_mxc no longer useful. Apply new non-exhaustive types: CrossSigningKey, OneTimeKey and SignedKey. Apply endpoint name change: send_state_event_for_key to send_state_event
3394 lines
113 KiB
Rust
3394 lines
113 KiB
Rust
// Copyright 2020 Damir Jelić
|
||
// Copyright 2020 The Matrix.org Foundation C.I.C.
|
||
//
|
||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||
// you may not use this file except in compliance with the License.
|
||
// You may obtain a copy of the License at
|
||
//
|
||
// http://www.apache.org/licenses/LICENSE-2.0
|
||
//
|
||
// Unless required by applicable law or agreed to in writing, software
|
||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
// See the License for the specific language governing permissions and
|
||
// limitations under the License.
|
||
|
||
#[cfg(feature = "encryption")]
|
||
use std::{collections::BTreeMap, io::Write, path::PathBuf};
|
||
#[cfg(feature = "sso_login")]
|
||
use std::{
|
||
collections::HashMap,
|
||
io::{Error as IoError, ErrorKind as IoErrorKind},
|
||
ops::Range,
|
||
};
|
||
use std::{
|
||
convert::TryInto,
|
||
fmt::{self, Debug},
|
||
future::Future,
|
||
io::Read,
|
||
path::Path,
|
||
result::Result as StdResult,
|
||
sync::Arc,
|
||
};
|
||
|
||
#[cfg(feature = "encryption")]
|
||
use dashmap::DashMap;
|
||
use futures_timer::Delay as sleep;
|
||
use http::HeaderValue;
|
||
#[cfg(feature = "sso_login")]
|
||
use http::Response;
|
||
use mime::{self, Mime};
|
||
#[cfg(feature = "sso_login")]
|
||
use rand::{thread_rng, Rng};
|
||
use reqwest::header::InvalidHeaderValue;
|
||
#[cfg(feature = "sso_login")]
|
||
use tokio::{net::TcpListener, sync::oneshot};
|
||
#[cfg(feature = "sso_login")]
|
||
use tokio_stream::wrappers::TcpListenerStream;
|
||
use url::Url;
|
||
#[cfg(feature = "sso_login")]
|
||
use warp::Filter;
|
||
#[cfg(feature = "encryption")]
|
||
use zeroize::Zeroizing;
|
||
|
||
#[cfg(feature = "encryption")]
|
||
use tracing::{debug, warn};
|
||
use tracing::{error, info, instrument};
|
||
|
||
use matrix_sdk_base::{
|
||
deserialized_responses::SyncResponse, events::AnyMessageEventContent, identifiers::MxcUri,
|
||
BaseClient, BaseClientConfig, Session, Store,
|
||
};
|
||
|
||
#[cfg(feature = "encryption")]
|
||
use matrix_sdk_base::crypto::{
|
||
decrypt_key_export, encrypt_key_export, olm::InboundGroupSession, store::CryptoStoreError,
|
||
OutgoingRequests, RoomMessageRequest, ToDeviceRequest,
|
||
};
|
||
|
||
/// Enum controlling if a loop running callbacks should continue or abort.
|
||
///
|
||
/// This is mainly used in the [`sync_with_callback`] method, the return value
|
||
/// of the provided callback controls if the sync loop should be exited.
|
||
///
|
||
/// [`sync_with_callback`]: #method.sync_with_callback
|
||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||
pub enum LoopCtrl {
|
||
/// Continue running the loop.
|
||
Continue,
|
||
/// Break out of the loop.
|
||
Break,
|
||
}
|
||
|
||
use matrix_sdk_common::{
|
||
api::r0::{
|
||
account::register,
|
||
device::{delete_devices, get_devices},
|
||
directory::{get_public_rooms, get_public_rooms_filtered},
|
||
filter::{create_filter::Request as FilterUploadRequest, FilterDefinition},
|
||
media::{create_content, get_content, get_content_thumbnail},
|
||
membership::{join_room_by_id, join_room_by_id_or_alias},
|
||
message::send_message_event,
|
||
profile::{get_avatar_url, get_display_name, set_avatar_url, set_display_name},
|
||
room::create_room,
|
||
session::{get_login_types, login, sso_login},
|
||
sync::sync_events,
|
||
uiaa::AuthData,
|
||
},
|
||
assign,
|
||
identifiers::{DeviceIdBox, EventId, RoomId, RoomIdOrAliasId, ServerName, UserId},
|
||
instant::{Duration, Instant},
|
||
locks::RwLock,
|
||
presence::PresenceState,
|
||
uuid::Uuid,
|
||
FromHttpResponseError, UInt,
|
||
};
|
||
|
||
#[cfg(feature = "encryption")]
|
||
use matrix_sdk_common::api::r0::{
|
||
keys::{get_keys, upload_keys, upload_signing_keys::Request as UploadSigningKeysRequest},
|
||
to_device::send_event_to_device::{
|
||
Request as RumaToDeviceRequest, Response as ToDeviceResponse,
|
||
},
|
||
};
|
||
|
||
use matrix_sdk_common::locks::Mutex;
|
||
|
||
use crate::{
|
||
error::HttpError,
|
||
http_client::{client_with_config, HttpClient, HttpSend},
|
||
room, Error, OutgoingRequest, Result,
|
||
};
|
||
|
||
#[cfg(feature = "encryption")]
|
||
use crate::{
|
||
device::{Device, UserDevices},
|
||
event_handler::Handler,
|
||
identifiers::DeviceId,
|
||
sas::Sas,
|
||
verification_request::VerificationRequest,
|
||
EventHandler,
|
||
};
|
||
|
||
const DEFAULT_SYNC_TIMEOUT: Duration = Duration::from_secs(30);
|
||
/// Give the sync a bit more time than the default request timeout does.
|
||
const SYNC_REQUEST_TIMEOUT: Duration = Duration::from_secs(15);
|
||
/// A conservative upload speed of 1Mbps
|
||
const DEFAULT_UPLOAD_SPEED: u64 = 125_000;
|
||
/// 5 min minimal upload request timeout, used to clamp the request timeout.
|
||
const MIN_UPLOAD_REQUEST_TIMEOUT: Duration = Duration::from_secs(60 * 5);
|
||
/// The range of ports the SSO server will try to bind to randomly
|
||
#[cfg(feature = "sso_login")]
|
||
const SSO_SERVER_BIND_RANGE: Range<u16> = 20000..30000;
|
||
/// The number of timesthe SSO server will try to bind to a random port
|
||
#[cfg(feature = "sso_login")]
|
||
const SSO_SERVER_BIND_TRIES: u8 = 10;
|
||
|
||
/// An async/await enabled Matrix client.
|
||
///
|
||
/// All of the state is held in an `Arc` so the `Client` can be cloned freely.
|
||
#[derive(Clone)]
|
||
pub struct Client {
|
||
/// The URL of the homeserver to connect to.
|
||
homeserver: Arc<Url>,
|
||
/// The underlying HTTP client.
|
||
http_client: HttpClient,
|
||
/// User session data.
|
||
pub(crate) base_client: BaseClient,
|
||
/// Locks making sure we only have one group session sharing request in
|
||
/// flight per room.
|
||
#[cfg(feature = "encryption")]
|
||
pub(crate) group_session_locks: Arc<DashMap<RoomId, Arc<Mutex<()>>>>,
|
||
#[cfg(feature = "encryption")]
|
||
/// Lock making sure we're only doing one key claim request at a time.
|
||
key_claim_lock: Arc<Mutex<()>>,
|
||
pub(crate) members_request_locks: Arc<DashMap<RoomId, Arc<Mutex<()>>>>,
|
||
pub(crate) typing_notice_times: Arc<DashMap<RoomId, Instant>>,
|
||
/// Any implementor of EventHandler will act as the callbacks for various
|
||
/// events.
|
||
event_handler: Arc<RwLock<Option<Handler>>>,
|
||
}
|
||
|
||
#[cfg(not(tarpaulin_include))]
|
||
impl Debug for Client {
|
||
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> StdResult<(), fmt::Error> {
|
||
write!(fmt, "Client {{ homeserver: {} }}", self.homeserver)
|
||
}
|
||
}
|
||
|
||
/// Configuration for the creation of the `Client`.
|
||
///
|
||
/// When setting the `StateStore` it is up to the user to open/connect
|
||
/// the storage backend before client creation.
|
||
///
|
||
/// # Example
|
||
///
|
||
/// ```
|
||
/// # use matrix_sdk::ClientConfig;
|
||
/// // To pass all the request through mitmproxy set the proxy and disable SSL
|
||
/// // verification
|
||
/// let client_config = ClientConfig::new()
|
||
/// .proxy("http://localhost:8080")
|
||
/// .unwrap()
|
||
/// .disable_ssl_verification();
|
||
/// ```
|
||
#[derive(Default)]
|
||
pub struct ClientConfig {
|
||
#[cfg(not(target_arch = "wasm32"))]
|
||
pub(crate) proxy: Option<reqwest::Proxy>,
|
||
pub(crate) user_agent: Option<HeaderValue>,
|
||
pub(crate) disable_ssl_verification: bool,
|
||
pub(crate) base_config: BaseClientConfig,
|
||
pub(crate) timeout: Option<Duration>,
|
||
pub(crate) client: Option<Arc<dyn HttpSend>>,
|
||
}
|
||
|
||
#[cfg(not(tarpaulin_include))]
|
||
impl Debug for ClientConfig {
|
||
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||
let mut res = fmt.debug_struct("ClientConfig");
|
||
|
||
#[cfg(not(target_arch = "wasm32"))]
|
||
let res = res.field("proxy", &self.proxy);
|
||
|
||
res.field("user_agent", &self.user_agent)
|
||
.field("disable_ssl_verification", &self.disable_ssl_verification)
|
||
.finish()
|
||
}
|
||
}
|
||
|
||
impl ClientConfig {
|
||
/// Create a new default `ClientConfig`.
|
||
pub fn new() -> Self {
|
||
Default::default()
|
||
}
|
||
|
||
/// Set the proxy through which all the HTTP requests should go.
|
||
///
|
||
/// Note, only HTTP proxies are supported.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `proxy` - The HTTP URL of the proxy.
|
||
///
|
||
/// # Example
|
||
///
|
||
/// ```
|
||
/// use matrix_sdk::ClientConfig;
|
||
///
|
||
/// let client_config = ClientConfig::new()
|
||
/// .proxy("http://localhost:8080")
|
||
/// .unwrap();
|
||
/// ```
|
||
#[cfg(not(target_arch = "wasm32"))]
|
||
pub fn proxy(mut self, proxy: &str) -> Result<Self> {
|
||
self.proxy = Some(reqwest::Proxy::all(proxy)?);
|
||
Ok(self)
|
||
}
|
||
|
||
/// Disable SSL verification for the HTTP requests.
|
||
pub fn disable_ssl_verification(mut self) -> Self {
|
||
self.disable_ssl_verification = true;
|
||
self
|
||
}
|
||
|
||
/// Set a custom HTTP user agent for the client.
|
||
pub fn user_agent(mut self, user_agent: &str) -> StdResult<Self, InvalidHeaderValue> {
|
||
self.user_agent = Some(HeaderValue::from_str(user_agent)?);
|
||
Ok(self)
|
||
}
|
||
|
||
///// Set a custom implementation of a `StateStore`.
|
||
/////
|
||
///// The state store should be opened before being set.
|
||
//pub fn state_store(mut self, store: Box<dyn StateStore>) -> Self {
|
||
// self.base_config = self.base_config.state_store(store);
|
||
// self
|
||
//}
|
||
|
||
/// Set the path for storage.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `path` - The path where the stores should save data in. It is the
|
||
/// callers responsibility to make sure that the path exists.
|
||
///
|
||
/// In the default configuration the client will open default
|
||
/// implementations for the crypto store and the state store. It will use
|
||
/// the given path to open the stores. If no path is provided no store will
|
||
/// be opened
|
||
pub fn store_path(mut self, path: impl AsRef<Path>) -> Self {
|
||
self.base_config = self.base_config.store_path(path);
|
||
self
|
||
}
|
||
|
||
/// Set the passphrase to encrypt the crypto store.
|
||
///
|
||
/// # Argument
|
||
///
|
||
/// * `passphrase` - The passphrase that will be used to encrypt the data in
|
||
/// the cryptostore.
|
||
///
|
||
/// This is only used if no custom cryptostore is set.
|
||
pub fn passphrase(mut self, passphrase: String) -> Self {
|
||
self.base_config = self.base_config.passphrase(passphrase);
|
||
self
|
||
}
|
||
|
||
/// Set a timeout duration for all HTTP requests. The default is no timeout.
|
||
pub fn timeout(mut self, timeout: Duration) -> Self {
|
||
self.timeout = Some(timeout);
|
||
self
|
||
}
|
||
|
||
/// Specify a client to handle sending requests and receiving responses.
|
||
///
|
||
/// Any type that implements the `HttpSend` trait can be used to send/receive
|
||
/// `http` types.
|
||
pub fn client(mut self, client: Arc<dyn HttpSend>) -> Self {
|
||
self.client = Some(client);
|
||
self
|
||
}
|
||
}
|
||
|
||
#[derive(Debug, Default, Clone)]
|
||
/// Settings for a sync call.
|
||
pub struct SyncSettings<'a> {
|
||
pub(crate) filter: Option<sync_events::Filter<'a>>,
|
||
pub(crate) timeout: Option<Duration>,
|
||
pub(crate) token: Option<String>,
|
||
pub(crate) full_state: bool,
|
||
}
|
||
|
||
impl<'a> SyncSettings<'a> {
|
||
/// Create new default sync settings.
|
||
pub fn new() -> Self {
|
||
Default::default()
|
||
}
|
||
|
||
/// Set the sync token.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `token` - The sync token that should be used for the sync call.
|
||
pub fn token(mut self, token: impl Into<String>) -> Self {
|
||
self.token = Some(token.into());
|
||
self
|
||
}
|
||
|
||
/// Set the maximum time the server can wait, in milliseconds, before
|
||
/// responding to the sync request.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `timeout` - The time the server is allowed to wait.
|
||
pub fn timeout(mut self, timeout: Duration) -> Self {
|
||
self.timeout = Some(timeout);
|
||
self
|
||
}
|
||
|
||
/// Set the sync filter.
|
||
/// It can be either the filter ID, or the definition for the filter.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `filter` - The filter configuration that should be used for the sync call.
|
||
pub fn filter(mut self, filter: sync_events::Filter<'a>) -> Self {
|
||
self.filter = Some(filter);
|
||
self
|
||
}
|
||
|
||
/// Should the server return the full state from the start of the timeline.
|
||
///
|
||
/// This does nothing if no sync token is set.
|
||
///
|
||
/// # Arguments
|
||
/// * `full_state` - A boolean deciding if the server should return the full
|
||
/// state or not.
|
||
pub fn full_state(mut self, full_state: bool) -> Self {
|
||
self.full_state = full_state;
|
||
self
|
||
}
|
||
}
|
||
|
||
impl Client {
|
||
/// Creates a new client for making HTTP requests to the given homeserver.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `homeserver_url` - The homeserver that the client should connect to.
|
||
pub fn new(homeserver_url: impl TryInto<Url>) -> Result<Self> {
|
||
let config = ClientConfig::new();
|
||
Client::new_with_config(homeserver_url, config)
|
||
}
|
||
|
||
/// Create a new client with the given configuration.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `homeserver_url` - The homeserver that the client should connect to.
|
||
///
|
||
/// * `config` - Configuration for the client.
|
||
pub fn new_with_config(
|
||
homeserver_url: impl TryInto<Url>,
|
||
config: ClientConfig,
|
||
) -> Result<Self> {
|
||
let homeserver = if let Ok(u) = homeserver_url.try_into() {
|
||
Arc::new(u)
|
||
} else {
|
||
panic!("Error parsing homeserver url")
|
||
};
|
||
|
||
let client = if let Some(client) = config.client {
|
||
client
|
||
} else {
|
||
Arc::new(client_with_config(&config)?)
|
||
};
|
||
|
||
let base_client = BaseClient::new_with_config(config.base_config)?;
|
||
let session = base_client.session().clone();
|
||
|
||
let http_client = HttpClient {
|
||
homeserver: homeserver.clone(),
|
||
inner: client,
|
||
session,
|
||
};
|
||
|
||
Ok(Self {
|
||
homeserver,
|
||
http_client,
|
||
base_client,
|
||
#[cfg(feature = "encryption")]
|
||
group_session_locks: Arc::new(DashMap::new()),
|
||
#[cfg(feature = "encryption")]
|
||
key_claim_lock: Arc::new(Mutex::new(())),
|
||
members_request_locks: Arc::new(DashMap::new()),
|
||
typing_notice_times: Arc::new(DashMap::new()),
|
||
event_handler: Arc::new(RwLock::new(None)),
|
||
})
|
||
}
|
||
|
||
/// Is the client logged in.
|
||
pub async fn logged_in(&self) -> bool {
|
||
self.base_client.logged_in().await
|
||
}
|
||
|
||
/// The Homeserver of the client.
|
||
pub fn homeserver(&self) -> &Url {
|
||
&self.homeserver
|
||
}
|
||
|
||
/// Get the user id of the current owner of the client.
|
||
pub async fn user_id(&self) -> Option<UserId> {
|
||
let session = self.base_client.session().read().await;
|
||
session.as_ref().cloned().map(|s| s.user_id)
|
||
}
|
||
|
||
/// Get the device id that identifies the current session.
|
||
pub async fn device_id(&self) -> Option<DeviceIdBox> {
|
||
let session = self.base_client.session().read().await;
|
||
session.as_ref().map(|s| s.device_id.clone())
|
||
}
|
||
|
||
/// Fetches the display name of the owner of the client.
|
||
///
|
||
/// # Example
|
||
/// ```no_run
|
||
/// # use futures::executor::block_on;
|
||
/// # use matrix_sdk::Client;
|
||
/// # use url::Url;
|
||
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
||
/// # block_on(async {
|
||
/// let user = "example";
|
||
/// let client = Client::new(homeserver).unwrap();
|
||
/// client.login(user, "password", None, None).await.unwrap();
|
||
///
|
||
/// if let Some(name) = client.display_name().await.unwrap() {
|
||
/// println!("Logged in as user '{}' with display name '{}'", user, name);
|
||
/// }
|
||
/// # })
|
||
/// ```
|
||
pub async fn display_name(&self) -> Result<Option<String>> {
|
||
let user_id = self.user_id().await.ok_or(Error::AuthenticationRequired)?;
|
||
let request = get_display_name::Request::new(&user_id);
|
||
let response = self.send(request, None).await?;
|
||
Ok(response.displayname)
|
||
}
|
||
|
||
/// Sets the display name of the owner of the client.
|
||
///
|
||
/// # Example
|
||
/// ```no_run
|
||
/// # use futures::executor::block_on;
|
||
/// # use matrix_sdk::Client;
|
||
/// # use url::Url;
|
||
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
||
/// # block_on(async {
|
||
/// let user = "example";
|
||
/// let client = Client::new(homeserver).unwrap();
|
||
/// client.login(user, "password", None, None).await.unwrap();
|
||
///
|
||
/// client.set_display_name(Some("Alice")).await.expect("Failed setting display name");
|
||
/// # })
|
||
/// ```
|
||
pub async fn set_display_name(&self, name: Option<&str>) -> Result<()> {
|
||
let user_id = self.user_id().await.ok_or(Error::AuthenticationRequired)?;
|
||
let request = set_display_name::Request::new(&user_id, name);
|
||
self.send(request, None).await?;
|
||
Ok(())
|
||
}
|
||
|
||
/// Gets the mxc avatar url of the owner of the client, if set.
|
||
///
|
||
/// # Example
|
||
/// ```no_run
|
||
/// # use futures::executor::block_on;
|
||
/// # use matrix_sdk::Client;
|
||
/// # use url::Url;
|
||
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
||
/// # block_on(async {
|
||
/// # let user = "example";
|
||
/// let client = Client::new(homeserver).unwrap();
|
||
/// client.login(user, "password", None, None).await.unwrap();
|
||
///
|
||
/// if let Some(url) = client.avatar_url().await.unwrap() {
|
||
/// println!("Your avatar's mxc url is {}", url);
|
||
/// }
|
||
/// # })
|
||
/// ```
|
||
pub async fn avatar_url(&self) -> Result<Option<MxcUri>> {
|
||
let user_id = self.user_id().await.ok_or(Error::AuthenticationRequired)?;
|
||
let request = get_avatar_url::Request::new(&user_id);
|
||
let response = self.send(request, None).await?;
|
||
Ok(response.avatar_url)
|
||
}
|
||
|
||
/// Gets the avatar of the owner of the client, if set.
|
||
///
|
||
/// Returns the avatar. No guarantee on the size of the image is given.
|
||
/// If no size is given the full-sized avatar will be returned.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `width` - The desired width of the avatar.
|
||
///
|
||
/// * `height` - The desired height of the avatar.
|
||
///
|
||
/// # Example
|
||
/// ```no_run
|
||
/// # use futures::executor::block_on;
|
||
/// # use matrix_sdk::Client;
|
||
/// # use matrix_sdk::identifiers::room_id;
|
||
/// # use url::Url;
|
||
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
||
/// # block_on(async {
|
||
/// # let user = "example";
|
||
/// let client = Client::new(homeserver).unwrap();
|
||
/// client.login(user, "password", None, None).await.unwrap();
|
||
///
|
||
/// if let Some(avatar) = client.avatar(Some(96), Some(96)).await.unwrap() {
|
||
/// std::fs::write("avatar.png", avatar);
|
||
/// }
|
||
/// # })
|
||
/// ```
|
||
pub async fn avatar(&self, width: Option<u32>, height: Option<u32>) -> Result<Option<Vec<u8>>> {
|
||
// TODO: try to offer the avatar from cache, requires avatar cache
|
||
if let Some(url) = self.avatar_url().await? {
|
||
if let (Some(width), Some(height)) = (width, height) {
|
||
let request =
|
||
get_content_thumbnail::Request::from_url(&url, width.into(), height.into());
|
||
let response = self.send(request, None).await?;
|
||
Ok(Some(response.file))
|
||
} else {
|
||
let request = get_content::Request::from_url(&url);
|
||
let response = self.send(request, None).await?;
|
||
Ok(Some(response.file))
|
||
}
|
||
} else {
|
||
Ok(None)
|
||
}
|
||
}
|
||
|
||
/// Get a reference to the store.
|
||
pub fn store(&self) -> &Store {
|
||
self.base_client.store()
|
||
}
|
||
|
||
/// Sets the mxc avatar url of the client's owner. The avatar gets unset if `url` is `None`.
|
||
pub async fn set_avatar_url(&self, url: Option<&MxcUri>) -> Result<()> {
|
||
let user_id = self.user_id().await.ok_or(Error::AuthenticationRequired)?;
|
||
let request = set_avatar_url::Request::new(&user_id, url);
|
||
self.send(request, None).await?;
|
||
Ok(())
|
||
}
|
||
|
||
/// Upload and set the owning client's avatar.
|
||
///
|
||
/// The will upload the data produced by the reader to the homeserver's content repository, and
|
||
/// set the user's avatar to the mxc url for the uploaded file.
|
||
///
|
||
/// This is a convenience method for calling [`upload()`](#method.upload), followed by
|
||
/// [`set_avatar_url()`](#method.set_avatar_url).
|
||
///
|
||
/// # Example
|
||
/// ```no_run
|
||
/// # use std::{path::Path, fs::File, io::Read};
|
||
/// # use futures::executor::block_on;
|
||
/// # use matrix_sdk::Client;
|
||
/// # use url::Url;
|
||
/// # block_on(async {
|
||
/// # let homeserver = Url::parse("http://locahost:8080").unwrap();
|
||
/// # let client = Client::new(homeserver).unwrap();
|
||
/// let path = Path::new("/home/example/selfie.jpg");
|
||
/// let mut image = File::open(&path).unwrap();
|
||
///
|
||
/// client.upload_avatar(&mime::IMAGE_JPEG, &mut image).await.expect("Can't set avatar");
|
||
/// # })
|
||
/// ```
|
||
pub async fn upload_avatar<R: Read>(&self, content_type: &Mime, reader: &mut R) -> Result<()> {
|
||
let upload_response = self.upload(content_type, reader).await?;
|
||
self.set_avatar_url(Some(&upload_response.content_uri))
|
||
.await?;
|
||
Ok(())
|
||
}
|
||
|
||
/// Add `EventHandler` to `Client`.
|
||
///
|
||
/// The methods of `EventHandler` are called when the respective `RoomEvents` occur.
|
||
pub async fn set_event_handler(&self, handler: Box<dyn EventHandler>) {
|
||
let handler = Handler {
|
||
inner: handler,
|
||
client: self.clone(),
|
||
};
|
||
*self.event_handler.write().await = Some(handler);
|
||
}
|
||
|
||
/// Get all the rooms the client knows about.
|
||
///
|
||
/// This will return the list of joined, invited, and left rooms.
|
||
pub fn rooms(&self) -> Vec<room::Room> {
|
||
self.store()
|
||
.get_rooms()
|
||
.into_iter()
|
||
.map(|room| room::Common::new(self.clone(), room).into())
|
||
.collect()
|
||
}
|
||
|
||
/// Returns the joined rooms this client knows about.
|
||
pub fn joined_rooms(&self) -> Vec<room::Joined> {
|
||
self.store()
|
||
.get_rooms()
|
||
.into_iter()
|
||
.filter_map(|room| room::Joined::new(self.clone(), room))
|
||
.collect()
|
||
}
|
||
|
||
/// Returns the invited rooms this client knows about.
|
||
pub fn invited_rooms(&self) -> Vec<room::Invited> {
|
||
self.store()
|
||
.get_rooms()
|
||
.into_iter()
|
||
.filter_map(|room| room::Invited::new(self.clone(), room))
|
||
.collect()
|
||
}
|
||
|
||
/// Returns the left rooms this client knows about.
|
||
pub fn left_rooms(&self) -> Vec<room::Left> {
|
||
self.store()
|
||
.get_rooms()
|
||
.into_iter()
|
||
.filter_map(|room| room::Left::new(self.clone(), room))
|
||
.collect()
|
||
}
|
||
|
||
/// Get a room with the given room id.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// `room_id` - The unique id of the room that should be fetched.
|
||
pub fn get_room(&self, room_id: &RoomId) -> Option<room::Room> {
|
||
self.store()
|
||
.get_room(room_id)
|
||
.map(|room| room::Common::new(self.clone(), room).into())
|
||
}
|
||
|
||
/// Get a joined room with the given room id.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// `room_id` - The unique id of the room that should be fetched.
|
||
pub fn get_joined_room(&self, room_id: &RoomId) -> Option<room::Joined> {
|
||
self.store()
|
||
.get_room(room_id)
|
||
.and_then(|room| room::Joined::new(self.clone(), room))
|
||
}
|
||
|
||
/// Get an invited room with the given room id.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// `room_id` - The unique id of the room that should be fetched.
|
||
pub fn get_invited_room(&self, room_id: &RoomId) -> Option<room::Invited> {
|
||
self.store()
|
||
.get_room(room_id)
|
||
.and_then(|room| room::Invited::new(self.clone(), room))
|
||
}
|
||
|
||
/// Get a left room with the given room id.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// `room_id` - The unique id of the room that should be fetched.
|
||
pub fn get_left_room(&self, room_id: &RoomId) -> Option<room::Left> {
|
||
self.store()
|
||
.get_room(room_id)
|
||
.and_then(|room| room::Left::new(self.clone(), room))
|
||
}
|
||
|
||
/// Gets the homeserver’s supported login types.
|
||
///
|
||
/// This should be the first step when trying to login so you can call the
|
||
/// appropriate method for the next step.
|
||
pub async fn get_login_types(&self) -> Result<get_login_types::Response> {
|
||
let request = get_login_types::Request::new();
|
||
self.send(request, None).await
|
||
}
|
||
|
||
/// Get the URL to use to login via Single Sign-On.
|
||
///
|
||
/// Returns a URL that should be opened in a web browser to let the user
|
||
/// login.
|
||
///
|
||
/// After a successful login, the loginToken received at the redirect URL should
|
||
/// be used to login with [`login_with_token`].
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `redirect_url` - The URL that will receive a `loginToken` after a
|
||
/// successful SSO login.
|
||
///
|
||
/// [`login_with_token`]: #method.login_with_token
|
||
pub fn get_sso_login_url(&self, redirect_url: &str) -> Result<String> {
|
||
let homeserver = self.homeserver();
|
||
let request =
|
||
sso_login::Request::new(redirect_url).try_into_http_request(homeserver.as_str(), None);
|
||
match request {
|
||
Ok(req) => Ok(req.uri().to_string()),
|
||
Err(err) => Err(Error::from(HttpError::from(err))),
|
||
}
|
||
}
|
||
|
||
/// Login to the server.
|
||
///
|
||
/// This can be used for the first login as well as for subsequent logins,
|
||
/// note that if the device id isn't provided a new device will be created.
|
||
///
|
||
/// If this isn't the first login a device id should be provided to restore
|
||
/// the correct stores.
|
||
///
|
||
/// Alternatively the [`restore_login`] method can be used to restore a
|
||
/// logged in client without the password.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `user` - The user that should be logged in to the homeserver.
|
||
///
|
||
/// * `password` - The password of the user.
|
||
///
|
||
/// * `device_id` - A unique id that will be associated with this session. If
|
||
/// not given the homeserver will create one. Can be an existing
|
||
/// device_id from a previous login call. Note that this should be done
|
||
/// only if the client also holds the encryption keys for this device.
|
||
///
|
||
/// # Example
|
||
/// ```no_run
|
||
/// # use std::convert::TryFrom;
|
||
/// # use matrix_sdk::Client;
|
||
/// # use matrix_sdk::identifiers::DeviceId;
|
||
/// # use matrix_sdk_common::assign;
|
||
/// # use futures::executor::block_on;
|
||
/// # use url::Url;
|
||
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
||
/// # block_on(async {
|
||
/// let client = Client::new(homeserver).unwrap();
|
||
/// let user = "example";
|
||
/// let response = client
|
||
/// .login(user, "wordpass", None, Some("My bot")).await
|
||
/// .unwrap();
|
||
///
|
||
/// println!("Logged in as {}, got device_id {} and access_token {}",
|
||
/// user, response.device_id, response.access_token);
|
||
/// # })
|
||
/// ```
|
||
///
|
||
/// [`restore_login`]: #method.restore_login
|
||
#[instrument(skip(password))]
|
||
pub async fn login(
|
||
&self,
|
||
user: &str,
|
||
password: &str,
|
||
device_id: Option<&str>,
|
||
initial_device_display_name: Option<&str>,
|
||
) -> Result<login::Response> {
|
||
info!("Logging in to {} as {:?}", self.homeserver, user);
|
||
|
||
let request = assign!(
|
||
login::Request::new(
|
||
login::LoginInfo::Password { identifier: login::UserIdentifier::MatrixId(user), password },
|
||
), {
|
||
device_id: device_id.map(|d| d.into()),
|
||
initial_device_display_name,
|
||
}
|
||
);
|
||
|
||
let response = self.send(request, None).await?;
|
||
self.base_client.receive_login_response(&response).await?;
|
||
|
||
Ok(response)
|
||
}
|
||
|
||
/// Login to the server via Single Sign-On.
|
||
///
|
||
/// This takes care of the whole SSO flow:
|
||
/// * Spawn a local http server
|
||
/// * Provide a callback to open the SSO login URL in a web browser
|
||
/// * Wait for the local http server to get the loginToken
|
||
/// * Call [`login_with_token`]
|
||
///
|
||
/// If cancellation is needed the method should be wrapped in a cancellable
|
||
/// task. **Note** that users with root access to the system have the ability
|
||
/// to snoop in on the data/token that is passed to the local HTTP server
|
||
/// that will be spawned.
|
||
///
|
||
/// If you need more control over the SSO login process, you should use
|
||
/// [`get_sso_login_url`] and [`login_with_token`] directly.
|
||
///
|
||
/// This should only be used for the first login.
|
||
///
|
||
/// The [`restore_login`] method should be used to restore a
|
||
/// logged in client after the first login.
|
||
///
|
||
/// A device id should be provided to restore the correct stores, if the
|
||
/// device id isn't provided a new device will be created.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `use_sso_login_url` - A callback that will receive the SSO Login URL. It
|
||
/// should usually be used to open the SSO URL in a browser and must return
|
||
/// `Ok(())` if the URL was successfully opened. If it returns `Err`, the
|
||
/// error will be forwarded.
|
||
///
|
||
/// * `server_url` - The local URL the server is going to try to bind to, e.g.
|
||
/// `http://localhost:3030`. If `None`, the server will try to open a random
|
||
/// port on localhost.
|
||
///
|
||
/// * `server_response` - The text that will be shown on the webpage at the end
|
||
/// of the login process. This can be an HTML page. If `None`, a default
|
||
/// text will be displayed.
|
||
///
|
||
/// * `device_id` - A unique id that will be associated with this session. If
|
||
/// not given the homeserver will create one. Can be an existing device_id
|
||
/// from a previous login call. Note that this should be provided only
|
||
/// if the client also holds the encryption keys for this device.
|
||
///
|
||
/// * `initial_device_display_name` - A public display name that will be
|
||
/// associated with the device_id. Only necessary the first time you
|
||
/// login with this device_id. It can be changed later.
|
||
///
|
||
/// # Example
|
||
/// ```no_run
|
||
/// # use matrix_sdk::Client;
|
||
/// # use futures::executor::block_on;
|
||
/// # use url::Url;
|
||
/// # let homeserver = Url::parse("https://example.com").unwrap();
|
||
/// # block_on(async {
|
||
/// let client = Client::new(homeserver).unwrap();
|
||
///
|
||
/// let response = client
|
||
/// .login_with_sso(
|
||
/// |sso_url| async move {
|
||
/// // Open sso_url
|
||
/// Ok(())
|
||
/// },
|
||
/// None,
|
||
/// None,
|
||
/// None,
|
||
/// Some("My app")
|
||
/// )
|
||
/// .await
|
||
/// .unwrap();
|
||
///
|
||
/// println!("Logged in as {}, got device_id {} and access_token {}",
|
||
/// response.user_id, response.device_id, response.access_token);
|
||
/// # })
|
||
/// ```
|
||
///
|
||
/// [`get_sso_login_url`]: #method.get_sso_login_url
|
||
/// [`login_with_token`]: #method.login_with_token
|
||
/// [`restore_login`]: #method.restore_login
|
||
#[cfg(all(feature = "sso_login", not(target_arch = "wasm32")))]
|
||
#[cfg_attr(
|
||
feature = "docs",
|
||
doc(cfg(all(sso_login, not(target_arch = "wasm32"))))
|
||
)]
|
||
pub async fn login_with_sso<C>(
|
||
&self,
|
||
use_sso_login_url: impl Fn(String) -> C,
|
||
server_url: Option<&str>,
|
||
server_response: Option<&str>,
|
||
device_id: Option<&str>,
|
||
initial_device_display_name: Option<&str>,
|
||
) -> Result<login::Response>
|
||
where
|
||
C: Future<Output = Result<()>>,
|
||
{
|
||
info!("Logging in to {}", self.homeserver);
|
||
let (signal_tx, signal_rx) = oneshot::channel();
|
||
let (data_tx, data_rx) = oneshot::channel();
|
||
let data_tx_mutex = Arc::new(std::sync::Mutex::new(Some(data_tx)));
|
||
|
||
let mut redirect_url = match server_url {
|
||
Some(s) => match Url::parse(s) {
|
||
Ok(url) => url,
|
||
Err(err) => return Err(IoError::new(IoErrorKind::InvalidData, err).into()),
|
||
},
|
||
None => Url::parse("http://localhost:0/").unwrap(),
|
||
};
|
||
|
||
let response = match server_response {
|
||
Some(s) => s.to_string(),
|
||
None => String::from(
|
||
"The Single Sign-On login process is complete. You can close this page now.",
|
||
),
|
||
};
|
||
|
||
let route = warp::get()
|
||
.and(warp::query::<HashMap<String, String>>())
|
||
.map(move |p: HashMap<String, String>| {
|
||
if let Some(data_tx) = data_tx_mutex.lock().unwrap().take() {
|
||
if let Some(token) = p.get("loginToken") {
|
||
data_tx.send(Some(token.to_owned())).unwrap();
|
||
} else {
|
||
data_tx.send(None).unwrap();
|
||
}
|
||
}
|
||
Response::builder().body(response.clone())
|
||
});
|
||
|
||
let listener = {
|
||
if redirect_url
|
||
.port()
|
||
.expect("The redirect URL doesn't include a port")
|
||
== 0
|
||
{
|
||
let host = redirect_url
|
||
.host_str()
|
||
.expect("The redirect URL doesn't have a host");
|
||
let mut n = 0u8;
|
||
let mut port = 0u16;
|
||
let mut res = Err(IoError::new(IoErrorKind::Other, ""));
|
||
let mut rng = thread_rng();
|
||
|
||
while res.is_err() && n < SSO_SERVER_BIND_TRIES {
|
||
port = rng.gen_range(SSO_SERVER_BIND_RANGE);
|
||
res = TcpListener::bind((host, port)).await;
|
||
n += 1;
|
||
}
|
||
match res {
|
||
Ok(s) => {
|
||
redirect_url
|
||
.set_port(Some(port))
|
||
.expect("Could not set new port on redirect URL");
|
||
s
|
||
}
|
||
Err(err) => return Err(err.into()),
|
||
}
|
||
} else {
|
||
match TcpListener::bind(redirect_url.as_str()).await {
|
||
Ok(s) => s,
|
||
Err(err) => return Err(err.into()),
|
||
}
|
||
}
|
||
};
|
||
|
||
let server = warp::serve(route).serve_incoming_with_graceful_shutdown(
|
||
TcpListenerStream::new(listener),
|
||
async {
|
||
signal_rx.await.ok();
|
||
},
|
||
);
|
||
|
||
tokio::spawn(server);
|
||
|
||
let sso_url = self.get_sso_login_url(redirect_url.as_str()).unwrap();
|
||
|
||
match use_sso_login_url(sso_url).await {
|
||
Ok(t) => t,
|
||
Err(err) => return Err(err),
|
||
};
|
||
|
||
let token = match data_rx.await {
|
||
Ok(Some(t)) => t,
|
||
Ok(None) => {
|
||
return Err(IoError::new(IoErrorKind::Other, "Could not get the loginToken").into())
|
||
}
|
||
Err(err) => return Err(IoError::new(IoErrorKind::Other, format!("{}", err)).into()),
|
||
};
|
||
|
||
let _ = signal_tx.send(());
|
||
|
||
self.login_with_token(token.as_str(), device_id, initial_device_display_name)
|
||
.await
|
||
}
|
||
|
||
/// Login to the server with a token.
|
||
///
|
||
/// This token is usually received in the SSO flow after following the URL
|
||
/// provided by [`get_sso_login_url`], note that this is not the access token
|
||
/// of a session.
|
||
///
|
||
/// This should only be used for the first login.
|
||
///
|
||
/// The [`restore_login`] method should be used to restore a
|
||
/// logged in client after the first login.
|
||
///
|
||
/// A device id should be provided to restore the correct stores, if the
|
||
/// device id isn't provided a new device will be created.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `token` - A login token.
|
||
///
|
||
/// * `device_id` - A unique id that will be associated with this session. If
|
||
/// not given the homeserver will create one. Can be an existing device_id
|
||
/// from a previous login call. Note that this should be provided only
|
||
/// if the client also holds the encryption keys for this device.
|
||
///
|
||
/// * `initial_device_display_name` - A public display name that will be
|
||
/// associated with the device_id. Only necessary the first time you
|
||
/// login with this device_id. It can be changed later.
|
||
///
|
||
/// # Example
|
||
/// ```no_run
|
||
/// # use std::convert::TryFrom;
|
||
/// # use matrix_sdk::Client;
|
||
/// # use matrix_sdk::identifiers::DeviceId;
|
||
/// # use matrix_sdk_common::assign;
|
||
/// # use futures::executor::block_on;
|
||
/// # use url::Url;
|
||
/// # let homeserver = Url::parse("https://example.com").unwrap();
|
||
/// # let redirect_url = "http://localhost:1234";
|
||
/// # let login_token = "token";
|
||
/// # block_on(async {
|
||
/// let client = Client::new(homeserver).unwrap();
|
||
/// let sso_url = client.get_sso_login_url(redirect_url);
|
||
///
|
||
/// // Let the user authenticate at the SSO URL
|
||
/// // Receive the loginToken param at redirect_url
|
||
///
|
||
/// let response = client
|
||
/// .login_with_token(login_token, None, Some("My app")).await
|
||
/// .unwrap();
|
||
///
|
||
/// println!("Logged in as {}, got device_id {} and access_token {}",
|
||
/// response.user_id, response.device_id, response.access_token);
|
||
/// # })
|
||
/// ```
|
||
///
|
||
/// [`get_sso_login_url`]: #method.get_sso_login_url
|
||
/// [`restore_login`]: #method.restore_login
|
||
#[instrument(skip(token))]
|
||
pub async fn login_with_token(
|
||
&self,
|
||
token: &str,
|
||
device_id: Option<&str>,
|
||
initial_device_display_name: Option<&str>,
|
||
) -> Result<login::Response> {
|
||
info!("Logging in to {}", self.homeserver);
|
||
|
||
let request = assign!(
|
||
login::Request::new(
|
||
login::LoginInfo::Token { token },
|
||
), {
|
||
device_id: device_id.map(|d| d.into()),
|
||
initial_device_display_name,
|
||
}
|
||
);
|
||
|
||
let response = self.send(request, None).await?;
|
||
self.base_client.receive_login_response(&response).await?;
|
||
|
||
Ok(response)
|
||
}
|
||
|
||
/// Restore a previously logged in session.
|
||
///
|
||
/// This can be used to restore the client to a logged in state, loading all
|
||
/// the stored state and encryption keys.
|
||
///
|
||
/// Alternatively, if the whole session isn't stored the [`login`] method
|
||
/// can be used with a device id.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `session` - A session that the user already has from a
|
||
/// previous login call.
|
||
///
|
||
/// [`login`]: #method.login
|
||
pub async fn restore_login(&self, session: Session) -> Result<()> {
|
||
Ok(self.base_client.restore_login(session).await?)
|
||
}
|
||
|
||
/// Register a user to the server.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `registration` - The easiest way to create this request is using the `register::Request`
|
||
/// itself.
|
||
///
|
||
///
|
||
/// # Examples
|
||
/// ```no_run
|
||
/// # use std::convert::TryFrom;
|
||
/// # use matrix_sdk::Client;
|
||
/// # use matrix_sdk::api::r0::account::register::{Request as RegistrationRequest, RegistrationKind};
|
||
/// # use matrix_sdk::api::r0::uiaa::AuthData;
|
||
/// # use matrix_sdk::identifiers::DeviceId;
|
||
/// # use matrix_sdk_common::assign;
|
||
/// # use futures::executor::block_on;
|
||
/// # use url::Url;
|
||
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
||
/// # block_on(async {
|
||
///
|
||
/// let request = assign!(RegistrationRequest::new(), {
|
||
/// username: Some("user"),
|
||
/// password: Some("password"),
|
||
/// auth: Some(AuthData::FallbackAcknowledgement { session: "foobar" }),
|
||
/// });
|
||
/// let client = Client::new(homeserver).unwrap();
|
||
/// client.register(request).await;
|
||
/// # })
|
||
/// ```
|
||
#[instrument(skip(registration))]
|
||
pub async fn register(
|
||
&self,
|
||
registration: impl Into<register::Request<'_>>,
|
||
) -> Result<register::Response> {
|
||
info!("Registering to {}", self.homeserver);
|
||
|
||
let request = registration.into();
|
||
self.send(request, None).await
|
||
}
|
||
|
||
/// Get or upload a sync filter.
|
||
pub async fn get_or_upload_filter(
|
||
&self,
|
||
filter_name: &str,
|
||
definition: FilterDefinition<'_>,
|
||
) -> Result<String> {
|
||
if let Some(filter) = self.base_client.get_filter(filter_name).await? {
|
||
Ok(filter)
|
||
} else {
|
||
let user_id = self.user_id().await.ok_or(Error::AuthenticationRequired)?;
|
||
let request = FilterUploadRequest::new(&user_id, definition);
|
||
let response = self.send(request, None).await?;
|
||
|
||
self.base_client
|
||
.receive_filter_upload(filter_name, &response)
|
||
.await?;
|
||
|
||
Ok(response.filter_id)
|
||
}
|
||
}
|
||
|
||
/// Join a room by `RoomId`.
|
||
///
|
||
/// Returns a `join_room_by_id::Response` consisting of the
|
||
/// joined rooms `RoomId`.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `room_id` - The `RoomId` of the room to be joined.
|
||
pub async fn join_room_by_id(&self, room_id: &RoomId) -> Result<join_room_by_id::Response> {
|
||
let request = join_room_by_id::Request::new(room_id);
|
||
self.send(request, None).await
|
||
}
|
||
|
||
/// Join a room by `RoomId`.
|
||
///
|
||
/// Returns a `join_room_by_id_or_alias::Response` consisting of the
|
||
/// joined rooms `RoomId`.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `alias` - The `RoomId` or `RoomAliasId` of the room to be joined.
|
||
/// An alias looks like `#name:example.com`.
|
||
pub async fn join_room_by_id_or_alias(
|
||
&self,
|
||
alias: &RoomIdOrAliasId,
|
||
server_names: &[Box<ServerName>],
|
||
) -> Result<join_room_by_id_or_alias::Response> {
|
||
let request = assign!(join_room_by_id_or_alias::Request::new(alias), {
|
||
server_name: server_names,
|
||
});
|
||
self.send(request, None).await
|
||
}
|
||
|
||
/// Search the homeserver's directory of public rooms.
|
||
///
|
||
/// Sends a request to "_matrix/client/r0/publicRooms", returns
|
||
/// a `get_public_rooms::Response`.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `limit` - The number of `PublicRoomsChunk`s in each response.
|
||
///
|
||
/// * `since` - Pagination token from a previous request.
|
||
///
|
||
/// * `server` - The name of the server, if `None` the requested server is used.
|
||
///
|
||
/// # Examples
|
||
/// ```no_run
|
||
/// use matrix_sdk::Client;
|
||
/// # use std::convert::TryInto;
|
||
/// # use url::Url;
|
||
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
||
/// # let limit = Some(10);
|
||
/// # let since = Some("since token");
|
||
/// # let server = Some("servername.com".try_into().unwrap());
|
||
///
|
||
/// let mut client = Client::new(homeserver).unwrap();
|
||
/// # use futures::executor::block_on;
|
||
/// # block_on(async {
|
||
///
|
||
/// client.public_rooms(limit, since, server).await;
|
||
/// # });
|
||
/// ```
|
||
pub async fn public_rooms(
|
||
&self,
|
||
limit: Option<u32>,
|
||
since: Option<&str>,
|
||
server: Option<&ServerName>,
|
||
) -> Result<get_public_rooms::Response> {
|
||
let limit = limit.map(UInt::from);
|
||
|
||
let request = assign!(get_public_rooms::Request::new(), {
|
||
limit,
|
||
since,
|
||
server,
|
||
});
|
||
self.send(request, None).await
|
||
}
|
||
|
||
/// Create a room using the `RoomBuilder` and send the request.
|
||
///
|
||
/// Sends a request to `/_matrix/client/r0/createRoom`, returns a `create_room::Response`,
|
||
/// this is an empty response.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `room` - The easiest way to create this request is using the
|
||
/// `create_room::Request` itself.
|
||
///
|
||
/// # Examples
|
||
/// ```no_run
|
||
/// use matrix_sdk::Client;
|
||
/// # use matrix_sdk::api::r0::room::{create_room::Request as CreateRoomRequest, Visibility};
|
||
/// # use url::Url;
|
||
///
|
||
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
||
/// let request = CreateRoomRequest::new();
|
||
/// let client = Client::new(homeserver).unwrap();
|
||
/// # use futures::executor::block_on;
|
||
/// # block_on(async {
|
||
/// assert!(client.create_room(request).await.is_ok());
|
||
/// # });
|
||
/// ```
|
||
pub async fn create_room(
|
||
&self,
|
||
room: impl Into<create_room::Request<'_>>,
|
||
) -> Result<create_room::Response> {
|
||
let request = room.into();
|
||
self.send(request, None).await
|
||
}
|
||
|
||
/// Search the homeserver's directory of public rooms with a filter.
|
||
///
|
||
/// Sends a request to "_matrix/client/r0/publicRooms", returns
|
||
/// a `get_public_rooms_filtered::Response`.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `room_search` - The easiest way to create this request is using the
|
||
/// `get_public_rooms_filtered::Request` itself.
|
||
///
|
||
/// # Examples
|
||
/// ```no_run
|
||
/// # use std::convert::TryFrom;
|
||
/// # use matrix_sdk::Client;
|
||
/// # use matrix_sdk::directory::{Filter, RoomNetwork};
|
||
/// # use matrix_sdk::api::r0::directory::get_public_rooms_filtered::Request as PublicRoomsFilterRequest;
|
||
/// # use matrix_sdk_common::assign;
|
||
/// # use url::Url;
|
||
/// # use futures::executor::block_on;
|
||
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
||
/// # block_on(async {
|
||
/// let mut client = Client::new(homeserver).unwrap();
|
||
///
|
||
/// let generic_search_term = Some("matrix-rust-sdk");
|
||
/// let filter = assign!(Filter::new(), { generic_search_term });
|
||
/// let request = assign!(PublicRoomsFilterRequest::new(), { filter });
|
||
///
|
||
/// client.public_rooms_filtered(request).await;
|
||
/// # })
|
||
/// ```
|
||
pub async fn public_rooms_filtered(
|
||
&self,
|
||
room_search: impl Into<get_public_rooms_filtered::Request<'_>>,
|
||
) -> Result<get_public_rooms_filtered::Response> {
|
||
let request = room_search.into();
|
||
self.send(request, None).await
|
||
}
|
||
|
||
#[cfg(feature = "encryption")]
|
||
pub(crate) async fn room_send_helper(
|
||
&self,
|
||
request: &RoomMessageRequest,
|
||
) -> Result<send_message_event::Response> {
|
||
let content = request.content.clone();
|
||
let txn_id = request.txn_id;
|
||
let room_id = &request.room_id;
|
||
|
||
self.get_joined_room(room_id)
|
||
.expect("Can't send a message to a room that isn't known to the store")
|
||
.send(content, Some(txn_id))
|
||
.await
|
||
}
|
||
|
||
/// Upload some media to the server.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `content_type` - The type of the media, this will be used as the
|
||
/// content-type header.
|
||
///
|
||
/// * `reader` - A `Reader` that will be used to fetch the raw bytes of the
|
||
/// media.
|
||
///
|
||
/// # Examples
|
||
///
|
||
/// ```no_run
|
||
/// # use std::{path::PathBuf, fs::File, io::Read};
|
||
/// # use matrix_sdk::{Client, identifiers::room_id};
|
||
/// # use url::Url;
|
||
/// # use futures::executor::block_on;
|
||
/// # use mime;
|
||
/// # block_on(async {
|
||
/// # let homeserver = Url::parse("http://localhost:8080").unwrap();
|
||
/// # let mut client = Client::new(homeserver).unwrap();
|
||
/// let path = PathBuf::from("/home/example/my-cat.jpg");
|
||
/// let mut image = File::open(path).unwrap();
|
||
///
|
||
/// let response = client
|
||
/// .upload(&mime::IMAGE_JPEG, &mut image)
|
||
/// .await
|
||
/// .expect("Can't upload my cat.");
|
||
///
|
||
/// println!("Cat URI: {}", response.content_uri);
|
||
/// # });
|
||
/// ```
|
||
pub async fn upload(
|
||
&self,
|
||
content_type: &Mime,
|
||
reader: &mut impl Read,
|
||
) -> Result<create_content::Response> {
|
||
let mut data = Vec::new();
|
||
reader.read_to_end(&mut data)?;
|
||
|
||
let timeout = std::cmp::max(
|
||
Duration::from_secs(data.len() as u64 / DEFAULT_UPLOAD_SPEED),
|
||
MIN_UPLOAD_REQUEST_TIMEOUT,
|
||
);
|
||
|
||
let request = assign!(create_content::Request::new(data), {
|
||
content_type: Some(content_type.essence_str()),
|
||
});
|
||
|
||
Ok(self.http_client.upload(request, Some(timeout)).await?)
|
||
}
|
||
|
||
/// Send a room message to a room.
|
||
///
|
||
/// Returns the parsed response from the server.
|
||
///
|
||
/// If the encryption feature is enabled this method will transparently
|
||
/// encrypt the room message if this room is encrypted.
|
||
///
|
||
/// **Note**: This method will send an unencrypted message if the room cannot
|
||
/// be found in the store, prefer the higher level
|
||
/// [send()](room::Joined::send()) method that can be found for the
|
||
/// [Joined](room::Joined) room struct to avoid this.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `room_id` - The unique id of the room.
|
||
///
|
||
/// * `content` - The content of the message event.
|
||
///
|
||
/// * `txn_id` - A unique `Uuid` that can be attached to a `MessageEvent`
|
||
/// held in its unsigned field as `transaction_id`. If not given one is
|
||
/// created for the message.
|
||
///
|
||
/// # Example
|
||
/// ```no_run
|
||
/// # use std::sync::{Arc, RwLock};
|
||
/// # use matrix_sdk::{Client, SyncSettings};
|
||
/// # use url::Url;
|
||
/// # use futures::executor::block_on;
|
||
/// # use matrix_sdk::identifiers::room_id;
|
||
/// # use std::convert::TryFrom;
|
||
/// use matrix_sdk::events::{
|
||
/// AnyMessageEventContent,
|
||
/// room::message::{MessageEventContent, TextMessageEventContent},
|
||
/// };
|
||
/// # block_on(async {
|
||
/// # let homeserver = Url::parse("http://localhost:8080").unwrap();
|
||
/// # let mut client = Client::new(homeserver).unwrap();
|
||
/// # let room_id = room_id!("!test:localhost");
|
||
/// use matrix_sdk_common::uuid::Uuid;
|
||
///
|
||
/// let content = AnyMessageEventContent::RoomMessage(
|
||
/// MessageEventContent::text_plain("Hello world")
|
||
/// );
|
||
///
|
||
/// let txn_id = Uuid::new_v4();
|
||
/// client.room_send(&room_id, content, Some(txn_id)).await.unwrap();
|
||
/// # })
|
||
/// ```
|
||
pub async fn room_send(
|
||
&self,
|
||
room_id: &RoomId,
|
||
content: impl Into<AnyMessageEventContent>,
|
||
txn_id: Option<Uuid>,
|
||
) -> Result<send_message_event::Response> {
|
||
#[cfg(feature = "encryption")]
|
||
if let Some(room) = self.get_joined_room(room_id) {
|
||
room.send(content, txn_id).await
|
||
} else {
|
||
let content = content.into();
|
||
let txn_id = txn_id.unwrap_or_else(Uuid::new_v4).to_string();
|
||
let request = send_message_event::Request::new(room_id, &txn_id, &content);
|
||
|
||
self.send(request, None).await
|
||
}
|
||
}
|
||
|
||
/// Send an arbitrary request to the server, without updating client state.
|
||
///
|
||
/// **Warning:** Because this method *does not* update the client state, it is
|
||
/// important to make sure than you account for this yourself, and use wrapper methods
|
||
/// where available. This method should *only* be used if a wrapper method for the
|
||
/// endpoint you'd like to use is not available.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `request` - A filled out and valid request for the endpoint to be hit
|
||
///
|
||
/// * `timeout` - An optional request timeout setting, this overrides the
|
||
/// default request setting if one was set.
|
||
///
|
||
/// # Example
|
||
///
|
||
/// ```no_run
|
||
/// # use matrix_sdk::{Client, SyncSettings};
|
||
/// # use futures::executor::block_on;
|
||
/// # use url::Url;
|
||
/// # use std::convert::TryFrom;
|
||
/// # block_on(async {
|
||
/// # let homeserver = Url::parse("http://localhost:8080").unwrap();
|
||
/// # let mut client = Client::new(homeserver).unwrap();
|
||
/// use matrix_sdk::api::r0::profile;
|
||
/// use matrix_sdk::identifiers::user_id;
|
||
///
|
||
/// // First construct the request you want to make
|
||
/// // See https://docs.rs/ruma-client-api/latest/ruma_client_api/index.html
|
||
/// // for all available Endpoints
|
||
/// let user_id = user_id!("@example:localhost");
|
||
/// let request = profile::get_profile::Request::new(&user_id);
|
||
///
|
||
/// // Start the request using Client::send()
|
||
/// let response = client.send(request, None).await.unwrap();
|
||
///
|
||
/// // Check the corresponding Response struct to find out what types are
|
||
/// // returned
|
||
/// # })
|
||
/// ```
|
||
pub async fn send<Request>(
|
||
&self,
|
||
request: Request,
|
||
timeout: Option<Duration>,
|
||
) -> Result<Request::IncomingResponse>
|
||
where
|
||
Request: OutgoingRequest + Debug,
|
||
HttpError: From<FromHttpResponseError<Request::EndpointError>>,
|
||
{
|
||
Ok(self.http_client.send(request, timeout).await?)
|
||
}
|
||
|
||
#[cfg(feature = "encryption")]
|
||
pub(crate) async fn send_to_device(
|
||
&self,
|
||
request: &ToDeviceRequest,
|
||
) -> Result<ToDeviceResponse> {
|
||
let txn_id_string = request.txn_id_string();
|
||
let request = RumaToDeviceRequest::new(
|
||
request.event_type.clone(),
|
||
&txn_id_string,
|
||
request.messages.clone(),
|
||
);
|
||
|
||
self.send(request, None).await
|
||
}
|
||
|
||
/// Get information of all our own devices.
|
||
///
|
||
/// # Examples
|
||
///
|
||
/// ```no_run
|
||
/// # use matrix_sdk::{Client, SyncSettings};
|
||
/// # use futures::executor::block_on;
|
||
/// # use url::Url;
|
||
/// # use std::convert::TryFrom;
|
||
/// # block_on(async {
|
||
/// # let homeserver = Url::parse("http://localhost:8080").unwrap();
|
||
/// # let mut client = Client::new(homeserver).unwrap();
|
||
/// let response = client.devices().await.expect("Can't get devices from server");
|
||
///
|
||
/// for device in response.devices {
|
||
/// println!(
|
||
/// "Device: {} {}",
|
||
/// device.device_id,
|
||
/// device.display_name.as_deref().unwrap_or("")
|
||
/// );
|
||
/// }
|
||
/// # });
|
||
/// ```
|
||
pub async fn devices(&self) -> Result<get_devices::Response> {
|
||
let request = get_devices::Request::new();
|
||
|
||
self.send(request, None).await
|
||
}
|
||
|
||
/// Delete the given devices from the server.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `devices` - The list of devices that should be deleted from the
|
||
/// server.
|
||
///
|
||
/// * `auth_data` - This request requires user interactive auth, the first
|
||
/// request needs to set this to `None` and will always fail with an
|
||
/// `UiaaResponse`. The response will contain information for the
|
||
/// interactive auth and the same request needs to be made but this time
|
||
/// with some `auth_data` provided.
|
||
///
|
||
/// ```no_run
|
||
/// # use matrix_sdk::{
|
||
/// # api::r0::uiaa::{UiaaResponse, AuthData},
|
||
/// # Client, SyncSettings, Error, FromHttpResponseError, ServerError,
|
||
/// # };
|
||
/// # use futures::executor::block_on;
|
||
/// # use serde_json::json;
|
||
/// # use url::Url;
|
||
/// # use std::{collections::BTreeMap, convert::TryFrom};
|
||
/// # block_on(async {
|
||
/// # let homeserver = Url::parse("http://localhost:8080").unwrap();
|
||
/// # let mut client = Client::new(homeserver).unwrap();
|
||
/// let devices = &["DEVICEID".into()];
|
||
///
|
||
/// if let Err(e) = client.delete_devices(devices, None).await {
|
||
/// if let Some(info) = e.uiaa_response() {
|
||
/// let mut auth_parameters = BTreeMap::new();
|
||
///
|
||
/// let identifier = json!({
|
||
/// "type": "m.id.user",
|
||
/// "user": "example",
|
||
/// });
|
||
/// auth_parameters.insert("identifier".to_owned(), identifier);
|
||
/// auth_parameters.insert("password".to_owned(), "wordpass".into());
|
||
///
|
||
/// // This is needed because of https://github.com/matrix-org/synapse/issues/5665
|
||
/// auth_parameters.insert("user".to_owned(), "@example:localhost".into());
|
||
///
|
||
/// let auth_data = AuthData::DirectRequest {
|
||
/// kind: "m.login.password",
|
||
/// auth_parameters,
|
||
/// session: info.session.as_deref(),
|
||
/// };
|
||
///
|
||
/// client
|
||
/// .delete_devices(devices, Some(auth_data))
|
||
/// .await
|
||
/// .expect("Can't delete devices");
|
||
/// }
|
||
/// }
|
||
/// # });
|
||
pub async fn delete_devices(
|
||
&self,
|
||
devices: &[DeviceIdBox],
|
||
auth_data: Option<AuthData<'_>>,
|
||
) -> Result<delete_devices::Response> {
|
||
let mut request = delete_devices::Request::new(devices);
|
||
request.auth = auth_data;
|
||
|
||
self.send(request, None).await
|
||
}
|
||
|
||
/// Synchronize the client's state with the latest state on the server.
|
||
///
|
||
/// **Note**: You should not use this method to repeatedly sync if encryption
|
||
/// support is enabled, the [`sync`] method will make additional
|
||
/// requests between syncs that are needed for E2E encryption to work.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `sync_settings` - Settings for the sync call.
|
||
///
|
||
/// [`sync`]: #method.sync
|
||
#[instrument]
|
||
pub async fn sync_once(&self, sync_settings: SyncSettings<'_>) -> Result<SyncResponse> {
|
||
let request = assign!(sync_events::Request::new(), {
|
||
filter: sync_settings.filter.as_ref(),
|
||
since: sync_settings.token.as_deref(),
|
||
full_state: sync_settings.full_state,
|
||
set_presence: &PresenceState::Online,
|
||
timeout: sync_settings.timeout,
|
||
});
|
||
|
||
let timeout = sync_settings
|
||
.timeout
|
||
.unwrap_or_else(|| Duration::from_secs(0))
|
||
+ SYNC_REQUEST_TIMEOUT;
|
||
|
||
let response = self.send(request, Some(timeout)).await?;
|
||
let sync_response = self.base_client.receive_sync_response(response).await?;
|
||
|
||
if let Some(handler) = self.event_handler.read().await.as_ref() {
|
||
handler.handle_sync(&sync_response).await;
|
||
}
|
||
|
||
Ok(sync_response)
|
||
}
|
||
|
||
/// Repeatedly call sync to synchronize the client state with the server.
|
||
///
|
||
/// This method will never return, if cancellation is needed the method
|
||
/// should be wrapped in a cancelable task or the [`sync_with_callback`]
|
||
/// method can be used.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `sync_settings` - Settings for the sync call. Note that those settings
|
||
/// will be only used for the first sync call.
|
||
///
|
||
/// [`sync_with_callback`]: #method.sync_with_callback
|
||
pub async fn sync(&self, sync_settings: SyncSettings<'_>) {
|
||
self.sync_with_callback(sync_settings, |_| async { LoopCtrl::Continue })
|
||
.await
|
||
}
|
||
|
||
/// Repeatedly call sync to synchronize the client state with the server.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `sync_settings` - Settings for the sync call. Note that those settings
|
||
/// will be only used for the first sync call.
|
||
///
|
||
/// * `callback` - A callback that will be called every time a successful
|
||
/// response has been fetched from the server. The callback must return
|
||
/// a boolean which signalizes if the method should stop syncing. If the
|
||
/// callback returns `LoopCtrl::Continue` the sync will continue, if the
|
||
/// callback returns `LoopCtrl::Break` the sync will be stopped.
|
||
///
|
||
/// # Examples
|
||
///
|
||
/// The following example demonstrates how to sync forever while sending all
|
||
/// the interesting events through a mpsc channel to another thread e.g. a
|
||
/// UI thread.
|
||
///
|
||
/// ```no_run
|
||
/// # use matrix_sdk::events::{
|
||
/// # room::message::{MessageEvent, MessageEventContent, TextMessageEventContent},
|
||
/// # };
|
||
/// # use std::sync::{Arc, RwLock};
|
||
/// # use std::time::Duration;
|
||
/// # use matrix_sdk::{Client, SyncSettings, LoopCtrl};
|
||
/// # use url::Url;
|
||
/// # use futures::executor::block_on;
|
||
/// # block_on(async {
|
||
/// # let homeserver = Url::parse("http://localhost:8080").unwrap();
|
||
/// # let mut client = Client::new(homeserver).unwrap();
|
||
///
|
||
/// use tokio::sync::mpsc::channel;
|
||
///
|
||
/// let (tx, rx) = channel(100);
|
||
///
|
||
/// let sync_channel = &tx;
|
||
/// let sync_settings = SyncSettings::new()
|
||
/// .timeout(Duration::from_secs(30));
|
||
///
|
||
/// client
|
||
/// .sync_with_callback(sync_settings, |response| async move {
|
||
/// let channel = sync_channel;
|
||
///
|
||
/// for (room_id, room) in response.rooms.join {
|
||
/// for event in room.timeline.events {
|
||
/// channel.send(event).await.unwrap();
|
||
/// }
|
||
/// }
|
||
///
|
||
/// LoopCtrl::Continue
|
||
/// })
|
||
/// .await;
|
||
/// })
|
||
/// ```
|
||
#[instrument(skip(callback))]
|
||
pub async fn sync_with_callback<C>(
|
||
&self,
|
||
mut sync_settings: SyncSettings<'_>,
|
||
callback: impl Fn(SyncResponse) -> C,
|
||
) where
|
||
C: Future<Output = LoopCtrl>,
|
||
{
|
||
let mut last_sync_time: Option<Instant> = None;
|
||
|
||
if sync_settings.token.is_none() {
|
||
sync_settings.token = self.sync_token().await;
|
||
}
|
||
|
||
loop {
|
||
let filter = sync_settings.filter.clone();
|
||
let response = self.sync_once(sync_settings.clone()).await;
|
||
|
||
let response = match response {
|
||
Ok(r) => r,
|
||
Err(e) => {
|
||
error!("Received an invalid response: {}", e);
|
||
sleep::new(Duration::from_secs(1)).await;
|
||
continue;
|
||
}
|
||
};
|
||
|
||
#[cfg(feature = "encryption")]
|
||
{
|
||
// This is needed because sometimes we need to automatically
|
||
// claim some one-time keys to unwedge an exisitng Olm session.
|
||
if let Err(e) = self.claim_one_time_keys([].iter()).await {
|
||
warn!("Error while claiming one-time keys {:?}", e);
|
||
}
|
||
|
||
for r in self.base_client.outgoing_requests().await {
|
||
match r.request() {
|
||
OutgoingRequests::KeysQuery(request) => {
|
||
if let Err(e) = self
|
||
.keys_query(r.request_id(), request.device_keys.clone())
|
||
.await
|
||
{
|
||
warn!("Error while querying device keys {:?}", e);
|
||
}
|
||
}
|
||
OutgoingRequests::KeysUpload(request) => {
|
||
if let Err(e) = self.keys_upload(&r.request_id(), request).await {
|
||
warn!("Error while querying device keys {:?}", e);
|
||
}
|
||
}
|
||
OutgoingRequests::ToDeviceRequest(request) => {
|
||
// TODO remove this unwrap
|
||
if let Ok(resp) = self.send_to_device(&request).await {
|
||
self.base_client
|
||
.mark_request_as_sent(&r.request_id(), &resp)
|
||
.await
|
||
.unwrap();
|
||
}
|
||
}
|
||
OutgoingRequests::SignatureUpload(request) => {
|
||
// TODO remove this unwrap.
|
||
if let Ok(resp) = self.send(request.clone(), None).await {
|
||
self.base_client
|
||
.mark_request_as_sent(&r.request_id(), &resp)
|
||
.await
|
||
.unwrap();
|
||
}
|
||
}
|
||
OutgoingRequests::RoomMessage(request) => {
|
||
if let Ok(resp) = self.room_send_helper(request).await {
|
||
self.base_client
|
||
.mark_request_as_sent(&r.request_id(), &resp)
|
||
.await
|
||
.unwrap();
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
if callback(response).await == LoopCtrl::Break {
|
||
return;
|
||
}
|
||
|
||
let now = Instant::now();
|
||
|
||
// If the last sync happened less than a second ago, sleep for a
|
||
// while to not hammer out requests if the server doesn't respect
|
||
// the sync timeout.
|
||
if let Some(t) = last_sync_time {
|
||
if now - t <= Duration::from_secs(1) {
|
||
sleep::new(Duration::from_secs(1)).await;
|
||
}
|
||
}
|
||
|
||
last_sync_time = Some(now);
|
||
|
||
sync_settings = SyncSettings::new().timeout(DEFAULT_SYNC_TIMEOUT).token(
|
||
self.sync_token()
|
||
.await
|
||
.expect("No sync token found after initial sync"),
|
||
);
|
||
if let Some(f) = filter {
|
||
sync_settings = sync_settings.filter(f);
|
||
}
|
||
}
|
||
}
|
||
|
||
/// Claim one-time keys creating new Olm sessions.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `users` - The list of user/device pairs that we should claim keys for.
|
||
///
|
||
#[cfg(feature = "encryption")]
|
||
#[cfg_attr(feature = "docs", doc(cfg(encryption)))]
|
||
#[instrument(skip(users))]
|
||
pub(crate) async fn claim_one_time_keys(
|
||
&self,
|
||
users: impl Iterator<Item = &UserId>,
|
||
) -> Result<()> {
|
||
let _lock = self.key_claim_lock.lock().await;
|
||
|
||
if let Some((request_id, request)) = self.base_client.get_missing_sessions(users).await? {
|
||
let response = self.send(request, None).await?;
|
||
self.base_client
|
||
.mark_request_as_sent(&request_id, &response)
|
||
.await?;
|
||
}
|
||
|
||
Ok(())
|
||
}
|
||
|
||
/// Upload the E2E encryption keys.
|
||
///
|
||
/// This uploads the long lived device keys as well as the required amount
|
||
/// of one-time keys.
|
||
///
|
||
/// # Panics
|
||
///
|
||
/// Panics if the client isn't logged in, or if no encryption keys need to
|
||
/// be uploaded.
|
||
#[cfg(feature = "encryption")]
|
||
#[cfg_attr(feature = "docs", doc(cfg(encryption)))]
|
||
#[instrument]
|
||
async fn keys_upload(
|
||
&self,
|
||
request_id: &Uuid,
|
||
request: &upload_keys::Request,
|
||
) -> Result<upload_keys::Response> {
|
||
debug!(
|
||
"Uploading encryption keys device keys: {}, one-time-keys: {}",
|
||
request.device_keys.is_some(),
|
||
request.one_time_keys.as_ref().map_or(0, |k| k.len())
|
||
);
|
||
|
||
let response = self.send(request.clone(), None).await?;
|
||
self.base_client
|
||
.mark_request_as_sent(request_id, &response)
|
||
.await?;
|
||
|
||
Ok(response)
|
||
}
|
||
|
||
/// Get the current, if any, sync token of the client.
|
||
/// This will be None if the client didn't sync at least once.
|
||
pub async fn sync_token(&self) -> Option<String> {
|
||
self.base_client.sync_token().await
|
||
}
|
||
|
||
/// Query the server for users device keys.
|
||
///
|
||
/// # Panics
|
||
///
|
||
/// Panics if no key query needs to be done.
|
||
#[cfg(feature = "encryption")]
|
||
#[cfg_attr(feature = "docs", doc(cfg(encryption)))]
|
||
#[instrument]
|
||
async fn keys_query(
|
||
&self,
|
||
request_id: &Uuid,
|
||
device_keys: BTreeMap<UserId, Vec<DeviceIdBox>>,
|
||
) -> Result<get_keys::Response> {
|
||
let request = assign!(get_keys::Request::new(), { device_keys });
|
||
|
||
let response = self.send(request, None).await?;
|
||
self.base_client
|
||
.mark_request_as_sent(request_id, &response)
|
||
.await?;
|
||
|
||
Ok(response)
|
||
}
|
||
|
||
/// Get a `Sas` verification object with the given flow id.
|
||
#[cfg(feature = "encryption")]
|
||
#[cfg_attr(feature = "docs", doc(cfg(encryption)))]
|
||
pub async fn get_verification(&self, flow_id: &str) -> Option<Sas> {
|
||
self.base_client
|
||
.get_verification(flow_id)
|
||
.await
|
||
.map(|sas| Sas {
|
||
inner: sas,
|
||
client: self.clone(),
|
||
})
|
||
}
|
||
|
||
/// Get a `VerificationRequest` object with the given flow id.
|
||
#[cfg(feature = "encryption")]
|
||
#[cfg_attr(feature = "docs", doc(cfg(encryption)))]
|
||
pub async fn get_verification_request(&self, flow_id: &EventId) -> Option<VerificationRequest> {
|
||
let olm = self.base_client.olm_machine().await?;
|
||
|
||
olm.get_verification_request(flow_id).and_then(|r| {
|
||
if let Some(room) = self.get_joined_room(r.room_id()) {
|
||
Some(VerificationRequest { inner: r, room })
|
||
} else {
|
||
None
|
||
}
|
||
})
|
||
}
|
||
|
||
/// Get a specific device of a user.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `user_id` - The unique id of the user that the device belongs to.
|
||
///
|
||
/// * `device_id` - The unique id of the device.
|
||
///
|
||
/// Returns a `Device` if one is found and the crypto store didn't throw an
|
||
/// error.
|
||
///
|
||
/// This will always return None if the client hasn't been logged in.
|
||
///
|
||
/// # Example
|
||
///
|
||
/// ```no_run
|
||
/// # use std::convert::TryFrom;
|
||
/// # use matrix_sdk::{Client, identifiers::UserId};
|
||
/// # use url::Url;
|
||
/// # use futures::executor::block_on;
|
||
/// # let alice = UserId::try_from("@alice:example.org").unwrap();
|
||
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
||
/// # let client = Client::new(homeserver).unwrap();
|
||
/// # block_on(async {
|
||
/// let device = client.get_device(&alice, "DEVICEID".into())
|
||
/// .await
|
||
/// .unwrap()
|
||
/// .unwrap();
|
||
///
|
||
/// println!("{:?}", device.is_trusted());
|
||
///
|
||
/// let verification = device.start_verification().await.unwrap();
|
||
/// # });
|
||
/// ```
|
||
#[cfg(feature = "encryption")]
|
||
#[cfg_attr(feature = "docs", doc(cfg(encryption)))]
|
||
pub async fn get_device(
|
||
&self,
|
||
user_id: &UserId,
|
||
device_id: &DeviceId,
|
||
) -> StdResult<Option<Device>, CryptoStoreError> {
|
||
let device = self.base_client.get_device(user_id, device_id).await?;
|
||
|
||
Ok(device.map(|d| Device {
|
||
inner: d,
|
||
client: self.clone(),
|
||
}))
|
||
}
|
||
|
||
/// Create and upload a new cross signing identity.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `auth_data` - This request requires user interactive auth, the first
|
||
/// request needs to set this to `None` and will always fail with an
|
||
/// `UiaaResponse`. The response will contain information for the
|
||
/// interactive auth and the same request needs to be made but this time
|
||
/// with some `auth_data` provided.
|
||
///
|
||
/// # Examples
|
||
/// ```no_run
|
||
/// # use std::{convert::TryFrom, collections::BTreeMap};
|
||
/// # use matrix_sdk::{Client, identifiers::UserId};
|
||
/// # use matrix_sdk::api::r0::uiaa::AuthData;
|
||
/// # use url::Url;
|
||
/// # use futures::executor::block_on;
|
||
/// # use serde_json::json;
|
||
/// # let user_id = UserId::try_from("@alice:example.org").unwrap();
|
||
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
||
/// # let client = Client::new(homeserver).unwrap();
|
||
/// # block_on(async {
|
||
///
|
||
/// fn auth_data<'a>(user: &UserId, password: &str, session: Option<&'a str>) -> AuthData<'a> {
|
||
/// let mut auth_parameters = BTreeMap::new();
|
||
/// let identifier = json!({
|
||
/// "type": "m.id.user",
|
||
/// "user": user,
|
||
/// });
|
||
/// auth_parameters.insert("identifier".to_owned(), identifier);
|
||
/// auth_parameters.insert("password".to_owned(), password.to_owned().into());
|
||
/// // This is needed because of https://github.com/matrix-org/synapse/issues/5665
|
||
/// auth_parameters.insert("user".to_owned(), user.as_str().into());
|
||
/// AuthData::DirectRequest {
|
||
/// kind: "m.login.password",
|
||
/// auth_parameters,
|
||
/// session,
|
||
/// }
|
||
/// }
|
||
///
|
||
/// if let Err(e) = client.bootstrap_cross_signing(None).await {
|
||
/// if let Some(response) = e.uiaa_response() {
|
||
/// let auth_data = auth_data(&user_id, "wordpass", response.session.as_deref());
|
||
/// client
|
||
/// .bootstrap_cross_signing(Some(auth_data))
|
||
/// .await
|
||
/// .expect("Couldn't bootstrap cross signing")
|
||
/// } else {
|
||
/// panic!("Error durign cross signing bootstrap {:#?}", e);
|
||
/// }
|
||
/// }
|
||
/// # })
|
||
#[cfg(feature = "encryption")]
|
||
#[cfg_attr(feature = "docs", doc(cfg(encryption)))]
|
||
pub async fn bootstrap_cross_signing(&self, auth_data: Option<AuthData<'_>>) -> Result<()> {
|
||
let olm = self
|
||
.base_client
|
||
.olm_machine()
|
||
.await
|
||
.ok_or(Error::AuthenticationRequired)?;
|
||
|
||
let (request, signature_request) = olm.bootstrap_cross_signing(false).await?;
|
||
|
||
let request = assign!(UploadSigningKeysRequest::new(), {
|
||
auth: auth_data,
|
||
master_key: request.master_key,
|
||
self_signing_key: request.self_signing_key,
|
||
user_signing_key: request.user_signing_key,
|
||
});
|
||
|
||
self.send(request, None).await?;
|
||
self.send(signature_request, None).await?;
|
||
|
||
Ok(())
|
||
}
|
||
|
||
/// Get a map holding all the devices of an user.
|
||
///
|
||
/// This will always return an empty map if the client hasn't been logged
|
||
/// in.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `user_id` - The unique id of the user that the devices belong to.
|
||
///
|
||
/// # Example
|
||
///
|
||
/// ```no_run
|
||
/// # use std::convert::TryFrom;
|
||
/// # use matrix_sdk::{Client, identifiers::UserId};
|
||
/// # use url::Url;
|
||
/// # use futures::executor::block_on;
|
||
/// # let alice = UserId::try_from("@alice:example.org").unwrap();
|
||
/// # let homeserver = Url::parse("http://example.com").unwrap();
|
||
/// # let client = Client::new(homeserver).unwrap();
|
||
/// # block_on(async {
|
||
/// let devices = client.get_user_devices(&alice).await.unwrap();
|
||
///
|
||
/// for device in devices.devices() {
|
||
/// println!("{:?}", device);
|
||
/// }
|
||
/// # });
|
||
/// ```
|
||
#[cfg(feature = "encryption")]
|
||
#[cfg_attr(feature = "docs", doc(cfg(encryption)))]
|
||
pub async fn get_user_devices(
|
||
&self,
|
||
user_id: &UserId,
|
||
) -> StdResult<UserDevices, CryptoStoreError> {
|
||
let devices = self.base_client.get_user_devices(user_id).await?;
|
||
|
||
Ok(UserDevices {
|
||
inner: devices,
|
||
client: self.clone(),
|
||
})
|
||
}
|
||
|
||
/// Export E2EE keys that match the given predicate encrypting them with the
|
||
/// given passphrase.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `path` - The file path where the exported key file will be saved.
|
||
///
|
||
/// * `passphrase` - The passphrase that will be used to encrypt the exported
|
||
/// room keys.
|
||
///
|
||
/// * `predicate` - A closure that will be called for every known
|
||
/// `InboundGroupSession`, which represents a room key. If the closure
|
||
/// returns `true` the `InboundGroupSessoin` will be included in the export,
|
||
/// if the closure returns `false` it will not be included.
|
||
///
|
||
/// # Panics
|
||
///
|
||
/// This method will panic if it isn't run on a Tokio runtime.
|
||
///
|
||
/// This method will panic if it can't get enough randomness from the OS to
|
||
/// encrypt the exported keys securely.
|
||
///
|
||
/// # Examples
|
||
///
|
||
/// ```no_run
|
||
/// # use std::{path::PathBuf, time::Duration};
|
||
/// # use matrix_sdk::{
|
||
/// # Client, SyncSettings,
|
||
/// # identifiers::room_id,
|
||
/// # };
|
||
/// # use futures::executor::block_on;
|
||
/// # use url::Url;
|
||
/// # block_on(async {
|
||
/// # let homeserver = Url::parse("http://localhost:8080").unwrap();
|
||
/// # let mut client = Client::new(homeserver).unwrap();
|
||
/// let path = PathBuf::from("/home/example/e2e-keys.txt");
|
||
/// // Export all room keys.
|
||
/// client
|
||
/// .export_keys(path, "secret-passphrase", |_| true)
|
||
/// .await
|
||
/// .expect("Can't export keys.");
|
||
///
|
||
/// // Export only the room keys for a certain room.
|
||
/// let path = PathBuf::from("/home/example/e2e-room-keys.txt");
|
||
/// let room_id = room_id!("!test:localhost");
|
||
///
|
||
/// client
|
||
/// .export_keys(path, "secret-passphrase", |s| s.room_id() == &room_id)
|
||
/// .await
|
||
/// .expect("Can't export keys.");
|
||
/// # });
|
||
/// ```
|
||
#[cfg(feature = "encryption")]
|
||
#[cfg(not(target_arch = "wasm32"))]
|
||
#[cfg_attr(
|
||
feature = "docs",
|
||
doc(cfg(all(encryption, not(target_arch = "wasm32"))))
|
||
)]
|
||
pub async fn export_keys(
|
||
&self,
|
||
path: PathBuf,
|
||
passphrase: &str,
|
||
predicate: impl FnMut(&InboundGroupSession) -> bool,
|
||
) -> Result<()> {
|
||
let olm = self
|
||
.base_client
|
||
.olm_machine()
|
||
.await
|
||
.ok_or(Error::AuthenticationRequired)?;
|
||
|
||
let keys = olm.export_keys(predicate).await?;
|
||
let passphrase = Zeroizing::new(passphrase.to_owned());
|
||
|
||
let encrypt = move || -> Result<()> {
|
||
let export: String = encrypt_key_export(&keys, &passphrase, 500_000)?;
|
||
let mut file = std::fs::File::create(path)?;
|
||
file.write_all(&export.into_bytes())?;
|
||
Ok(())
|
||
};
|
||
|
||
let task = tokio::task::spawn_blocking(encrypt);
|
||
task.await.expect("Task join error")
|
||
}
|
||
|
||
/// Import E2EE keys from the given file path.
|
||
///
|
||
/// # Arguments
|
||
///
|
||
/// * `path` - The file path where the exported key file will can be found.
|
||
///
|
||
/// * `passphrase` - The passphrase that should be used to decrypt the
|
||
/// exported room keys.
|
||
///
|
||
/// Returns a tuple of numbers that represent the number of sessions that
|
||
/// were imported and the total number of sessions that were found in the
|
||
/// key export.
|
||
///
|
||
/// # Panics
|
||
///
|
||
/// This method will panic if it isn't run on a Tokio runtime.
|
||
///
|
||
/// ```no_run
|
||
/// # use std::{path::PathBuf, time::Duration};
|
||
/// # use matrix_sdk::{
|
||
/// # Client, SyncSettings,
|
||
/// # identifiers::room_id,
|
||
/// # };
|
||
/// # use futures::executor::block_on;
|
||
/// # use url::Url;
|
||
/// # block_on(async {
|
||
/// # let homeserver = Url::parse("http://localhost:8080").unwrap();
|
||
/// # let mut client = Client::new(homeserver).unwrap();
|
||
/// let path = PathBuf::from("/home/example/e2e-keys.txt");
|
||
/// client
|
||
/// .import_keys(path, "secret-passphrase")
|
||
/// .await
|
||
/// .expect("Can't import keys");
|
||
/// # });
|
||
/// ```
|
||
#[cfg(feature = "encryption")]
|
||
#[cfg(not(target_arch = "wasm32"))]
|
||
#[cfg_attr(
|
||
feature = "docs",
|
||
doc(cfg(all(encryption, not(target_arch = "wasm32"))))
|
||
)]
|
||
pub async fn import_keys(&self, path: PathBuf, passphrase: &str) -> Result<(usize, usize)> {
|
||
let olm = self
|
||
.base_client
|
||
.olm_machine()
|
||
.await
|
||
.ok_or(Error::AuthenticationRequired)?;
|
||
let passphrase = Zeroizing::new(passphrase.to_owned());
|
||
|
||
let decrypt = move || {
|
||
let file = std::fs::File::open(path)?;
|
||
decrypt_key_export(file, &passphrase)
|
||
};
|
||
|
||
let task = tokio::task::spawn_blocking(decrypt);
|
||
// TODO remove this unwrap.
|
||
let import = task.await.expect("Task join error").unwrap();
|
||
|
||
Ok(olm.import_keys(import).await?)
|
||
}
|
||
}
|
||
|
||
#[cfg(test)]
|
||
mod test {
|
||
use crate::{ClientConfig, HttpError};
|
||
|
||
use super::{
|
||
get_public_rooms, get_public_rooms_filtered, register::RegistrationKind, Client, Session,
|
||
SyncSettings, Url,
|
||
};
|
||
use matrix_sdk_base::{identifiers::mxc_uri, RoomMember};
|
||
use matrix_sdk_common::{
|
||
api::r0::{
|
||
account::register::Request as RegistrationRequest,
|
||
directory::get_public_rooms_filtered::Request as PublicRoomsFilterRequest,
|
||
membership::Invite3pid, session::get_login_types::LoginType, uiaa::AuthData,
|
||
},
|
||
assign,
|
||
directory::Filter,
|
||
events::{room::message::MessageEventContent, AnyMessageEventContent},
|
||
identifiers::{event_id, room_id, user_id},
|
||
thirdparty,
|
||
};
|
||
use matrix_sdk_test::{test_json, EventBuilder, EventsJson};
|
||
use mockito::{mock, Matcher};
|
||
use serde_json::json;
|
||
|
||
use std::{collections::BTreeMap, convert::TryInto, io::Cursor, str::FromStr, time::Duration};
|
||
|
||
async fn logged_in_client() -> Client {
|
||
let session = Session {
|
||
access_token: "1234".to_owned(),
|
||
user_id: user_id!("@example:localhost"),
|
||
device_id: "DEVICEID".into(),
|
||
};
|
||
let homeserver = url::Url::parse(&mockito::server_url()).unwrap();
|
||
let client = Client::new(homeserver).unwrap();
|
||
client.restore_login(session).await.unwrap();
|
||
|
||
client
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn login() {
|
||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||
|
||
let client = Client::new(homeserver).unwrap();
|
||
|
||
let _m_types = mock("GET", "/_matrix/client/r0/login")
|
||
.with_status(200)
|
||
.with_body(test_json::LOGIN_TYPES.to_string())
|
||
.create();
|
||
|
||
let can_password = client
|
||
.get_login_types()
|
||
.await
|
||
.unwrap()
|
||
.flows
|
||
.iter()
|
||
.any(|flow| flow == &LoginType::Password);
|
||
assert!(can_password);
|
||
|
||
let _m_login = mock("POST", "/_matrix/client/r0/login")
|
||
.with_status(200)
|
||
.with_body(test_json::LOGIN.to_string())
|
||
.create();
|
||
|
||
client
|
||
.login("example", "wordpass", None, None)
|
||
.await
|
||
.unwrap();
|
||
|
||
let logged_in = client.logged_in().await;
|
||
assert!(logged_in, "Client should be logged in");
|
||
}
|
||
|
||
#[cfg(feature = "sso_login")]
|
||
#[tokio::test]
|
||
async fn login_with_sso() {
|
||
let _m_login = mock("POST", "/_matrix/client/r0/login")
|
||
.with_status(200)
|
||
.with_body(test_json::LOGIN.to_string())
|
||
.create();
|
||
|
||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||
let client = Client::new(homeserver).unwrap();
|
||
|
||
client
|
||
.login_with_sso(
|
||
|sso_url| async move {
|
||
let sso_url = Url::parse(sso_url.as_str()).unwrap();
|
||
|
||
let (_, redirect) = sso_url
|
||
.query_pairs()
|
||
.find(|(key, _)| key == "redirectUrl")
|
||
.unwrap();
|
||
|
||
let mut redirect_url = Url::parse(redirect.into_owned().as_str()).unwrap();
|
||
redirect_url.set_query(Some("loginToken=tinytoken"));
|
||
|
||
reqwest::get(redirect_url.to_string()).await.unwrap();
|
||
|
||
Ok(())
|
||
},
|
||
None,
|
||
None,
|
||
None,
|
||
None,
|
||
)
|
||
.await
|
||
.unwrap();
|
||
|
||
let logged_in = client.logged_in().await;
|
||
assert!(logged_in, "Client should be logged in");
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn login_with_sso_token() {
|
||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||
|
||
let client = Client::new(homeserver).unwrap();
|
||
|
||
let _m = mock("GET", "/_matrix/client/r0/login")
|
||
.with_status(200)
|
||
.with_body(test_json::LOGIN_TYPES.to_string())
|
||
.create();
|
||
|
||
let can_sso = client
|
||
.get_login_types()
|
||
.await
|
||
.unwrap()
|
||
.flows
|
||
.iter()
|
||
.any(|flow| flow == &LoginType::Sso);
|
||
assert!(can_sso);
|
||
|
||
let sso_url = client.get_sso_login_url("http://127.0.0.1:3030");
|
||
assert!(sso_url.is_ok());
|
||
|
||
let _m = mock("POST", "/_matrix/client/r0/login")
|
||
.with_status(200)
|
||
.with_body(test_json::LOGIN.to_string())
|
||
.create();
|
||
|
||
client
|
||
.login_with_token("averysmalltoken", None, None)
|
||
.await
|
||
.unwrap();
|
||
|
||
let logged_in = client.logged_in().await;
|
||
assert!(logged_in, "Client should be logged in");
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn devices() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock("GET", "/_matrix/client/r0/devices")
|
||
.with_status(200)
|
||
.with_body(test_json::DEVICES.to_string())
|
||
.create();
|
||
|
||
assert!(client.devices().await.is_ok());
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn test_join_leave_room() {
|
||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||
|
||
let room_id = room_id!("!SVkFJHzfwvuaIEawgC:localhost");
|
||
|
||
let session = Session {
|
||
access_token: "1234".to_owned(),
|
||
user_id: user_id!("@example:localhost"),
|
||
device_id: "DEVICEID".into(),
|
||
};
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let client = Client::new(homeserver.clone()).unwrap();
|
||
client.restore_login(session.clone()).await.unwrap();
|
||
|
||
let room = client.get_joined_room(&room_id);
|
||
assert!(room.is_none());
|
||
|
||
client.sync_once(SyncSettings::default()).await.unwrap();
|
||
|
||
let room = client.get_left_room(&room_id);
|
||
assert!(room.is_none());
|
||
|
||
let room = client.get_joined_room(&room_id);
|
||
assert!(room.is_some());
|
||
|
||
// test store reloads with correct room state from the sled store
|
||
let path = tempfile::tempdir().unwrap();
|
||
let config = ClientConfig::default().store_path(path);
|
||
let joined_client = Client::new_with_config(homeserver, config).unwrap();
|
||
joined_client.restore_login(session).await.unwrap();
|
||
|
||
// joined room reloaded from state store
|
||
joined_client
|
||
.sync_once(SyncSettings::default())
|
||
.await
|
||
.unwrap();
|
||
let room = joined_client.get_joined_room(&room_id);
|
||
assert!(room.is_some());
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.with_body(test_json::LEAVE_SYNC_EVENT.to_string())
|
||
.create();
|
||
|
||
joined_client
|
||
.sync_once(SyncSettings::default())
|
||
.await
|
||
.unwrap();
|
||
|
||
let room = joined_client.get_joined_room(&room_id);
|
||
assert!(room.is_none());
|
||
|
||
let room = joined_client.get_left_room(&room_id);
|
||
assert!(room.is_some());
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn account_data() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.with_body(test_json::SYNC.to_string())
|
||
.match_header("authorization", "Bearer 1234")
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
// let bc = &client.base_client;
|
||
// let ignored_users = bc.ignored_users.read().await;
|
||
// assert_eq!(1, ignored_users.len())
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn room_creation() {
|
||
let client = logged_in_client().await;
|
||
|
||
let response = EventBuilder::default()
|
||
.add_state_event(EventsJson::Member)
|
||
.add_state_event(EventsJson::PowerLevels)
|
||
.build_sync_response();
|
||
|
||
client
|
||
.base_client
|
||
.receive_sync_response(response)
|
||
.await
|
||
.unwrap();
|
||
let room_id = room_id!("!SVkFJHzfwvuaIEawgC:localhost");
|
||
|
||
assert_eq!(
|
||
client.homeserver(),
|
||
&Url::parse(&mockito::server_url()).unwrap()
|
||
);
|
||
|
||
let room = client.get_joined_room(&room_id);
|
||
assert!(room.is_some());
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn login_error() {
|
||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||
let client = Client::new(homeserver).unwrap();
|
||
|
||
let _m = mock("POST", "/_matrix/client/r0/login")
|
||
.with_status(403)
|
||
.with_body(test_json::LOGIN_RESPONSE_ERR.to_string())
|
||
.create();
|
||
|
||
if let Err(err) = client.login("example", "wordpass", None, None).await {
|
||
if let crate::Error::Http(HttpError::FromHttpResponse(
|
||
crate::FromHttpResponseError::Http(crate::ServerError::Known(crate::api::Error {
|
||
kind,
|
||
message,
|
||
status_code,
|
||
})),
|
||
)) = err
|
||
{
|
||
if let crate::api::error::ErrorKind::Forbidden = kind {
|
||
} else {
|
||
panic!(
|
||
"found the wrong `ErrorKind` {:?}, expected `Forbidden",
|
||
kind
|
||
);
|
||
}
|
||
assert_eq!(message, "Invalid password".to_string());
|
||
assert_eq!(status_code, http::StatusCode::from_u16(403).unwrap());
|
||
} else {
|
||
panic!(
|
||
"found the wrong `Error` type {:?}, expected `Error::RumaResponse",
|
||
err
|
||
);
|
||
}
|
||
} else {
|
||
panic!("this request should return an `Err` variant")
|
||
}
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn register_error() {
|
||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||
let client = Client::new(homeserver).unwrap();
|
||
|
||
let _m = mock("POST", "/_matrix/client/r0/register")
|
||
.with_status(403)
|
||
.with_body(test_json::REGISTRATION_RESPONSE_ERR.to_string())
|
||
.create();
|
||
|
||
let user = assign!(RegistrationRequest::new(), {
|
||
username: Some("user"),
|
||
password: Some("password"),
|
||
auth: Some(AuthData::FallbackAcknowledgement { session: "foobar" }),
|
||
kind: RegistrationKind::User,
|
||
});
|
||
|
||
if let Err(err) = client.register(user).await {
|
||
if let crate::Error::Http(HttpError::UiaaError(crate::FromHttpResponseError::Http(
|
||
// TODO this should be a UiaaError need to investigate
|
||
crate::ServerError::Unknown(e),
|
||
))) = err
|
||
{
|
||
assert!(e.to_string().starts_with("EOF while parsing"))
|
||
} else {
|
||
panic!(
|
||
"found the wrong `Error` type {:#?}, expected `ServerError::Unknown",
|
||
err
|
||
);
|
||
}
|
||
} else {
|
||
panic!("this request should return an `Err` variant")
|
||
}
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn join_room_by_id() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"POST",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/join".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.with_body(test_json::ROOM_ID.to_string())
|
||
.match_header("authorization", "Bearer 1234")
|
||
.create();
|
||
|
||
let room_id = room_id!("!testroom:example.org");
|
||
|
||
assert_eq!(
|
||
// this is the `join_by_room_id::Response` but since no PartialEq we check the RoomId field
|
||
client.join_room_by_id(&room_id).await.unwrap().room_id,
|
||
room_id
|
||
);
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn join_room_by_id_or_alias() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"POST",
|
||
Matcher::Regex(r"^/_matrix/client/r0/join/".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.with_body(test_json::ROOM_ID.to_string())
|
||
.match_header("authorization", "Bearer 1234")
|
||
.create();
|
||
|
||
let room_id = room_id!("!testroom:example.org").into();
|
||
|
||
assert_eq!(
|
||
// this is the `join_by_room_id::Response` but since no PartialEq we check the RoomId field
|
||
client
|
||
.join_room_by_id_or_alias(&room_id, &["server.com".try_into().unwrap()])
|
||
.await
|
||
.unwrap()
|
||
.room_id,
|
||
room_id!("!testroom:example.org")
|
||
);
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn invite_user_by_id() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"POST",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/invite".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.with_body(test_json::LOGOUT.to_string())
|
||
.match_header("authorization", "Bearer 1234")
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let user = user_id!("@example:localhost");
|
||
let room = client
|
||
.get_joined_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
|
||
room.invite_user_by_id(&user).await.unwrap();
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn invite_user_by_3pid() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"POST",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/invite".to_string()),
|
||
)
|
||
.with_status(200)
|
||
// empty JSON object
|
||
.with_body(test_json::LOGOUT.to_string())
|
||
.match_header("authorization", "Bearer 1234")
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let room = client
|
||
.get_joined_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
|
||
room.invite_user_by_3pid(Invite3pid {
|
||
id_server: "example.org",
|
||
id_access_token: "IdToken",
|
||
medium: thirdparty::Medium::Email,
|
||
address: "address",
|
||
})
|
||
.await
|
||
.unwrap();
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn room_search_all() {
|
||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||
let client = Client::new(homeserver).unwrap();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/publicRooms".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.with_body(test_json::PUBLIC_ROOMS.to_string())
|
||
.create();
|
||
|
||
let get_public_rooms::Response { chunk, .. } =
|
||
client.public_rooms(Some(10), None, None).await.unwrap();
|
||
assert_eq!(chunk.len(), 1);
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn room_search_filtered() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"POST",
|
||
Matcher::Regex(r"^/_matrix/client/r0/publicRooms".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.with_body(test_json::PUBLIC_ROOMS.to_string())
|
||
.match_header("authorization", "Bearer 1234")
|
||
.create();
|
||
|
||
let generic_search_term = Some("cheese");
|
||
let filter = assign!(Filter::new(), { generic_search_term });
|
||
let request = assign!(PublicRoomsFilterRequest::new(), { filter });
|
||
|
||
let get_public_rooms_filtered::Response { chunk, .. } =
|
||
client.public_rooms_filtered(request).await.unwrap();
|
||
assert_eq!(chunk.len(), 1);
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn leave_room() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"POST",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/leave".to_string()),
|
||
)
|
||
.with_status(200)
|
||
// this is an empty JSON object
|
||
.with_body(test_json::LOGOUT.to_string())
|
||
.match_header("authorization", "Bearer 1234")
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let room = client
|
||
.get_joined_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
|
||
room.leave().await.unwrap();
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn ban_user() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"POST",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/ban".to_string()),
|
||
)
|
||
.with_status(200)
|
||
// this is an empty JSON object
|
||
.with_body(test_json::LOGOUT.to_string())
|
||
.match_header("authorization", "Bearer 1234")
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let user = user_id!("@example:localhost");
|
||
let room = client
|
||
.get_joined_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
|
||
room.ban_user(&user, None).await.unwrap();
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn kick_user() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"POST",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/kick".to_string()),
|
||
)
|
||
.with_status(200)
|
||
// this is an empty JSON object
|
||
.with_body(test_json::LOGOUT.to_string())
|
||
.match_header("authorization", "Bearer 1234")
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let user = user_id!("@example:localhost");
|
||
let room = client
|
||
.get_joined_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
|
||
room.kick_user(&user, None).await.unwrap();
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn forget_room() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"POST",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/forget".to_string()),
|
||
)
|
||
.with_status(200)
|
||
// this is an empty JSON object
|
||
.with_body(test_json::LOGOUT.to_string())
|
||
.match_header("authorization", "Bearer 1234")
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::LEAVE_SYNC.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let room = client
|
||
.get_left_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
|
||
room.forget().await.unwrap();
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn read_receipt() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"POST",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/receipt".to_string()),
|
||
)
|
||
.with_status(200)
|
||
// this is an empty JSON object
|
||
.with_body(test_json::LOGOUT.to_string())
|
||
.match_header("authorization", "Bearer 1234")
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let event_id = event_id!("$xxxxxx:example.org");
|
||
let room = client
|
||
.get_joined_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
|
||
room.read_receipt(&event_id).await.unwrap();
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn read_marker() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"POST",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/read_markers".to_string()),
|
||
)
|
||
.with_status(200)
|
||
// this is an empty JSON object
|
||
.with_body(test_json::LOGOUT.to_string())
|
||
.match_header("authorization", "Bearer 1234")
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let event_id = event_id!("$xxxxxx:example.org");
|
||
let room = client
|
||
.get_joined_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
|
||
room.read_marker(&event_id, None).await.unwrap();
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn typing_notice() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"PUT",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/typing".to_string()),
|
||
)
|
||
.with_status(200)
|
||
// this is an empty JSON object
|
||
.with_body(test_json::LOGOUT.to_string())
|
||
.match_header("authorization", "Bearer 1234")
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let room = client
|
||
.get_joined_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
|
||
room.typing_notice(true).await.unwrap();
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn room_state_event_send() {
|
||
use crate::events::{
|
||
room::member::{MemberEventContent, MembershipState},
|
||
AnyStateEventContent,
|
||
};
|
||
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"PUT",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/state/.*".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::EVENT_ID.to_string())
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let room_id = room_id!("!SVkFJHzfwvuaIEawgC:localhost");
|
||
|
||
let room = client.get_joined_room(&room_id).unwrap();
|
||
|
||
let avatar_url = mxc_uri!("mxc://example.org/avA7ar");
|
||
let member_event = MemberEventContent {
|
||
avatar_url: Some(avatar_url),
|
||
membership: MembershipState::Join,
|
||
is_direct: None,
|
||
displayname: None,
|
||
third_party_invite: None,
|
||
};
|
||
let content = AnyStateEventContent::RoomMember(member_event);
|
||
let response = room.send_state_event(content, "").await.unwrap();
|
||
assert_eq!(event_id!("$h29iv0s8:example.com"), response.event_id);
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn room_message_send() {
|
||
use matrix_sdk_common::uuid::Uuid;
|
||
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"PUT",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/send/".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::EVENT_ID.to_string())
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let room = client
|
||
.get_joined_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
|
||
let content =
|
||
AnyMessageEventContent::RoomMessage(MessageEventContent::text_plain("Hello world"));
|
||
let txn_id = Uuid::new_v4();
|
||
let response = room.send(content, Some(txn_id)).await.unwrap();
|
||
|
||
assert_eq!(event_id!("$h29iv0s8:example.com"), response.event_id)
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn room_attachment_send() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"PUT",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/send/".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::EVENT_ID.to_string())
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"POST",
|
||
Matcher::Regex(r"^/_matrix/media/r0/upload".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("content-type", "image/jpeg")
|
||
.with_body(
|
||
json!({
|
||
"content_uri": "mxc://example.com/AQwafuaFswefuhsfAFAgsw"
|
||
})
|
||
.to_string(),
|
||
)
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let room = client
|
||
.get_joined_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
|
||
let mut media = Cursor::new("Hello world");
|
||
|
||
let response = room
|
||
.send_attachment("image", &mime::IMAGE_JPEG, &mut media, None)
|
||
.await
|
||
.unwrap();
|
||
|
||
assert_eq!(event_id!("$h29iv0s8:example.com"), response.event_id)
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn room_redact() {
|
||
use matrix_sdk_common::uuid::Uuid;
|
||
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"PUT",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/redact/.*?/.*?".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::EVENT_ID.to_string())
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let room = client
|
||
.get_joined_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
|
||
let event_id = event_id!("$xxxxxxxx:example.com");
|
||
|
||
let txn_id = Uuid::new_v4();
|
||
let reason = Some("Indecent material");
|
||
let response = room.redact(&event_id, reason, Some(txn_id)).await.unwrap();
|
||
|
||
assert_eq!(event_id!("$h29iv0s8:example.com"), response.event_id)
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn user_presence() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/rooms/.*/members".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::MEMBERS.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let room = client
|
||
.get_joined_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
let members: Vec<RoomMember> = room.active_members().await.unwrap();
|
||
|
||
assert_eq!(1, members.len());
|
||
// assert!(room.power_levels.is_some())
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn calculate_room_names_from_summary() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::DEFAULT_SYNC_SUMMARY.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
let room = client
|
||
.get_joined_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
|
||
assert_eq!("example2", room.display_name().await.unwrap());
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn invited_rooms() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::INVITE_SYNC.to_string())
|
||
.create();
|
||
|
||
let _response = client.sync_once(SyncSettings::default()).await.unwrap();
|
||
|
||
assert!(client.joined_rooms().is_empty());
|
||
assert!(client.left_rooms().is_empty());
|
||
assert!(!client.invited_rooms().is_empty());
|
||
|
||
assert!(client
|
||
.get_invited_room(&room_id!("!696r7674:example.com"))
|
||
.is_some());
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn left_rooms() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::LEAVE_SYNC.to_string())
|
||
.create();
|
||
|
||
let _response = client.sync_once(SyncSettings::default()).await.unwrap();
|
||
|
||
assert!(client.joined_rooms().is_empty());
|
||
assert!(!client.left_rooms().is_empty());
|
||
assert!(client.invited_rooms().is_empty());
|
||
|
||
assert!(client
|
||
.get_left_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.is_some())
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn sync() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.with_body(test_json::SYNC.to_string())
|
||
.match_header("authorization", "Bearer 1234")
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
assert_ne!(response.next_batch, "");
|
||
|
||
assert!(client.sync_token().await.is_some());
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn room_names() {
|
||
let client = logged_in_client().await;
|
||
|
||
let _m = mock(
|
||
"GET",
|
||
Matcher::Regex(r"^/_matrix/client/r0/sync\?.*$".to_string()),
|
||
)
|
||
.with_status(200)
|
||
.match_header("authorization", "Bearer 1234")
|
||
.with_body(test_json::SYNC.to_string())
|
||
.create();
|
||
|
||
let sync_settings = SyncSettings::new().timeout(Duration::from_millis(3000));
|
||
|
||
let _response = client.sync_once(sync_settings).await.unwrap();
|
||
|
||
let room = client
|
||
.get_joined_room(&room_id!("!SVkFJHzfwvuaIEawgC:localhost"))
|
||
.unwrap();
|
||
|
||
assert_eq!("tutorial".to_string(), room.display_name().await.unwrap());
|
||
}
|
||
|
||
#[tokio::test]
|
||
async fn delete_devices() {
|
||
let homeserver = Url::from_str(&mockito::server_url()).unwrap();
|
||
let client = Client::new(homeserver).unwrap();
|
||
|
||
let _m = mock("POST", "/_matrix/client/r0/delete_devices")
|
||
.with_status(401)
|
||
.with_body(
|
||
json!({
|
||
"flows": [
|
||
{
|
||
"stages": [
|
||
"m.login.password"
|
||
]
|
||
}
|
||
],
|
||
"params": {},
|
||
"session": "vBslorikviAjxzYBASOBGfPp"
|
||
})
|
||
.to_string(),
|
||
)
|
||
.create();
|
||
|
||
let _m = mock("POST", "/_matrix/client/r0/delete_devices")
|
||
.with_status(401)
|
||
// empty response
|
||
// TODO rename that response type.
|
||
.with_body(test_json::LOGOUT.to_string())
|
||
.create();
|
||
|
||
let devices = &["DEVICEID".into()];
|
||
|
||
if let Err(e) = client.delete_devices(devices, None).await {
|
||
if let Some(info) = e.uiaa_response() {
|
||
let mut auth_parameters = BTreeMap::new();
|
||
|
||
let identifier = json!({
|
||
"type": "m.id.user",
|
||
"user": "example",
|
||
});
|
||
auth_parameters.insert("identifier".to_owned(), identifier);
|
||
auth_parameters.insert("password".to_owned(), "wordpass".into());
|
||
|
||
let auth_data = AuthData::DirectRequest {
|
||
kind: "m.login.password",
|
||
auth_parameters,
|
||
session: info.session.as_deref(),
|
||
};
|
||
|
||
client
|
||
.delete_devices(devices, Some(auth_data))
|
||
.await
|
||
.unwrap();
|
||
}
|
||
}
|
||
}
|
||
}
|