//! Crate `ruma_client` is a [Matrix](https://matrix.org/) client library. #![deny(missing_debug_implementations)] #![deny(missing_docs)] #![feature(try_from)] use std::{convert::TryInto, str::FromStr, sync::{Arc, Mutex}}; use futures::{ future::{Future, FutureFrom, IntoFuture}, stream::{self, Stream}, }; use hyper::{ client::{connect::Connect, HttpConnector}, Client as HyperClient, Uri, }; #[cfg(feature = "hyper-tls")] use hyper_tls::HttpsConnector; #[cfg(feature = "hyper-tls")] use native_tls::Error as NativeTlsError; use ruma_api::Endpoint; use url::Url; pub use crate::{error::Error, session::Session}; /// Matrix client-server API endpoints. pub mod api; mod error; mod session; /// A client for the Matrix client-server API. #[derive(Debug)] pub struct Client(Arc>); /// Data contained in Client's Rc #[derive(Debug)] pub struct ClientData where C: Connect, { homeserver_url: Url, hyper: HyperClient, session: Mutex>, } impl Client { /// Creates a new client for making HTTP requests to the given homeserver. pub fn new(homeserver_url: Url, session: Option) -> Self { Client(Arc::new(ClientData { homeserver_url, hyper: HyperClient::builder().keep_alive(true).build_http(), session: Mutex::new(session), })) } } #[cfg(feature = "tls")] impl Client> { /// Creates a new client for making HTTPS requests to the given homeserver. pub fn https(homeserver_url: Url, session: Option) -> Result { let connector = HttpsConnector::new(4)?; Ok(Client(Arc::new(ClientData { homeserver_url, hyper: { HyperClient::builder().keep_alive(true).build(connector) }, session: Mutex::new(session), }))) } } impl Client where C: Connect + 'static, { /// Creates a new client using the given `hyper::Client`. /// /// This allows the user to configure the details of HTTP as desired. pub fn custom( hyper_client: HyperClient, homeserver_url: Url, session: Option, ) -> Self { Client(Arc::new(ClientData { homeserver_url, hyper: hyper_client, session: Mutex::new(session), })) } /// Log in with a username and password. /// /// In contrast to api::r0::session::login::call(), this method stores the /// session data returned by the endpoint in this client, instead of /// returning it. pub fn log_in( &self, user: String, password: String, device_id: Option, ) -> impl Future { use crate::api::r0::session::login; let data = self.0.clone(); login::call( self.clone(), login::Request { address: None, login_type: login::LoginType::Password, medium: None, device_id, password, user, }, ) .map(move |response| { let session = Session::new(response.access_token, response.user_id, response.device_id); *data.session.lock().unwrap() = Some(session.clone()); session }) } /// Register as a guest. In contrast to api::r0::account::register::call(), /// this method stores the session data returned by the endpoint in this /// client, instead of returning it. pub fn register_guest(&self) -> impl Future { use crate::api::r0::account::register; let data = self.0.clone(); register::call( self.clone(), register::Request { auth: None, bind_email: None, device_id: None, initial_device_display_name: None, kind: Some(register::RegistrationKind::Guest), password: None, username: None, }, ) .map(move |response| { let session = Session::new(response.access_token, response.user_id, response.device_id); *data.session.lock().unwrap() = Some(session.clone()); session }) } /// Register as a new user on this server. /// /// In contrast to api::r0::account::register::call(), this method stores /// the session data returned by the endpoint in this client, instead of /// returning it. /// /// The username is the local part of the returned user_id. If it is /// omitted from this request, the server will generate one. pub fn register_user( &self, username: Option, password: String, ) -> impl Future { use crate::api::r0::account::register; let data = self.0.clone(); register::call( self.clone(), register::Request { auth: None, bind_email: None, device_id: None, initial_device_display_name: None, kind: Some(register::RegistrationKind::User), password: Some(password), username, }, ) .map(move |response| { let session = Session::new(response.access_token, response.user_id, response.device_id); *data.session.lock().unwrap() = Some(session.clone()); session }) } /// Convenience method that represents repeated calls to the sync_events endpoint as a stream. /// /// If the since parameter is None, the first Item might take a significant time to arrive and /// be deserialized, because it contains all events that have occured in the whole lifetime of /// the logged-in users account and are visible to them. pub fn sync( &self, filter: Option, since: Option, set_presence: bool, ) -> impl Stream { use crate::api::r0::sync::sync_events; let client = self.clone(); let set_presence = if set_presence { None } else { Some(sync_events::SetPresence::Offline) }; stream::unfold(since, move |since| { Some( sync_events::call( client.clone(), sync_events::Request { filter: filter.clone(), since, full_state: None, set_presence: set_presence.clone(), timeout: None, }, ) .map(|res| { let next_batch_clone = res.next_batch.clone(); (res, Some(next_batch_clone)) }), ) }) } /// Makes a request to a Matrix API endpoint. pub(crate) fn request( self, request: ::Request, ) -> impl Future where E: Endpoint, { let data1 = self.0.clone(); let data2 = self.0.clone(); let mut url = self.0.homeserver_url.clone(); request .try_into() .map_err(Error::from) .into_future() .and_then(move |hyper_request| { { let uri = hyper_request.uri(); url.set_path(uri.path()); url.set_query(uri.query()); if E::METADATA.requires_authentication { if let Some(ref session) = *data1.session.lock().unwrap() { url.query_pairs_mut() .append_pair("access_token", session.access_token()); } else { return Err(Error::AuthenticationRequired); } } } Uri::from_str(url.as_ref()) .map(move |uri| (uri, hyper_request)) .map_err(Error::from) }) .and_then(move |(uri, mut hyper_request)| { *hyper_request.uri_mut() = uri; data2.hyper.request(hyper_request).map_err(Error::from) }) .and_then(|hyper_response| { E::Response::future_from(hyper_response).map_err(Error::from) }) } } impl Clone for Client { fn clone(&self) -> Client { Client(self.0.clone()) } }