// 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(all(not(target_arch = "wasm32")))] use std::sync::atomic::{AtomicU64, Ordering}; use std::{convert::TryFrom, fmt::Debug, sync::Arc}; #[cfg(all(not(target_arch = "wasm32")))] use backoff::{future::retry, Error as RetryError, ExponentialBackoff}; #[cfg(all(not(target_arch = "wasm32")))] use http::StatusCode; use http::{HeaderValue, Response as HttpResponse}; use matrix_sdk_common::{ api::r0::media::create_content, async_trait, locks::RwLock, AsyncTraitDeps, AuthScheme, FromHttpResponseError, IncomingResponse, SendAccessToken, }; use reqwest::{Client, Response}; use tracing::trace; use url::Url; use crate::{ error::HttpError, Bytes, BytesMut, ClientConfig, OutgoingRequest, RequestConfig, Session, }; /// Abstraction around the http layer. The allows implementors to use different /// http libraries. #[cfg_attr(target_arch = "wasm32", async_trait(?Send))] #[cfg_attr(not(target_arch = "wasm32"), async_trait)] pub trait HttpSend: AsyncTraitDeps { /// The method abstracting sending request types and receiving response /// types. /// /// This is called by the client every time it wants to send anything to a /// homeserver. /// /// # Arguments /// /// * `request` - The http request that has been converted from a ruma /// `Request`. /// /// * `request_config` - The config used for this request. /// /// # Examples /// /// ``` /// use std::convert::TryFrom; /// use matrix_sdk::{HttpSend, async_trait, HttpError, RequestConfig, Bytes}; /// /// #[derive(Debug)] /// struct Client(reqwest::Client); /// /// impl Client { /// async fn response_to_http_response( /// &self, /// mut response: reqwest::Response, /// ) -> Result, HttpError> { /// // Convert the reqwest response to a http one. /// todo!() /// } /// } /// /// #[async_trait] /// impl HttpSend for Client { /// async fn send_request( /// &self, /// request: http::Request, /// config: RequestConfig, /// ) -> Result, HttpError> { /// Ok(self /// .response_to_http_response( /// self.0 /// .execute(reqwest::Request::try_from(request)?) /// .await?, /// ) /// .await?) /// } /// } /// ``` async fn send_request( &self, request: http::Request, config: RequestConfig, ) -> Result, HttpError>; } #[derive(Clone, Debug)] pub(crate) struct HttpClient { pub(crate) inner: Arc, pub(crate) homeserver: Arc>, pub(crate) session: Arc>>, pub(crate) request_config: RequestConfig, } #[cfg(feature = "appservice")] use crate::OutgoingRequestAppserviceExt; impl HttpClient { pub(crate) fn new( inner: Arc, homeserver: Arc>, session: Arc>>, request_config: RequestConfig, ) -> Self { HttpClient { inner, homeserver, session, request_config } } async fn send_request( &self, request: Request, session: Arc>>, config: Option, ) -> Result, HttpError> { let config = match config { Some(config) => config, None => self.request_config, }; #[cfg(not(feature = "appservice"))] let request = self.try_into_http_request(request, session, config).await?; #[cfg(feature = "appservice")] let request = if !self.request_config.assert_identity { self.try_into_http_request(request, session, config).await? } else { self.try_into_http_request_with_identy_assertion(request, session, config).await? }; self.inner.send_request(request, config).await } async fn try_into_http_request( &self, request: Request, session: Arc>>, config: RequestConfig, ) -> Result, HttpError> { let read_guard; let access_token = if config.force_auth { read_guard = session.read().await; if let Some(session) = read_guard.as_ref() { SendAccessToken::Always(session.access_token.as_str()) } else { return Err(HttpError::ForcedAuthenticationWithoutAccessToken); } } else { match Request::METADATA.authentication { AuthScheme::AccessToken => { read_guard = session.read().await; if let Some(session) = read_guard.as_ref() { SendAccessToken::IfRequired(session.access_token.as_str()) } else { return Err(HttpError::AuthenticationRequired); } } AuthScheme::None => SendAccessToken::None, _ => return Err(HttpError::NotClientRequest), } }; let http_request = request .try_into_http_request::( &self.homeserver.read().await.to_string(), access_token, )? .map(|body| body.freeze()); Ok(http_request) } #[cfg(feature = "appservice")] async fn try_into_http_request_with_identy_assertion( &self, request: Request, session: Arc>>, _: RequestConfig, ) -> Result, HttpError> { let read_guard = session.read().await; let access_token = if let Some(session) = read_guard.as_ref() { SendAccessToken::Always(session.access_token.as_str()) } else { return Err(HttpError::AuthenticationRequired); }; let user_id = if let Some(session) = read_guard.as_ref() { session.user_id.clone() } else { return Err(HttpError::UserIdRequired); }; let http_request = request .try_into_http_request_with_user_id::( &self.homeserver.read().await.to_string(), access_token, user_id, )? .map(|body| body.freeze()); Ok(http_request) } pub async fn upload( &self, request: create_content::Request<'_>, config: Option, ) -> Result { let response = self.send_request(request, self.session.clone(), config).await?; Ok(create_content::Response::try_from_http_response(response)?) } pub async fn send( &self, request: Request, config: Option, ) -> Result where Request: OutgoingRequest + Debug, HttpError: From>, { let response = self.send_request(request, self.session.clone(), config).await?; trace!("Got response: {:?}", response); let response = Request::IncomingResponse::try_from_http_response(response)?; Ok(response) } } /// Build a client with the specified configuration. pub(crate) fn client_with_config(config: &ClientConfig) -> Result { let http_client = reqwest::Client::builder(); #[cfg(not(target_arch = "wasm32"))] let http_client = { let http_client = if config.disable_ssl_verification { http_client.danger_accept_invalid_certs(true) } else { http_client }; let http_client = match &config.proxy { Some(p) => http_client.proxy(p.clone()), None => http_client, }; let mut headers = reqwest::header::HeaderMap::new(); let user_agent = match &config.user_agent { Some(a) => a.clone(), None => HeaderValue::from_str(&format!("matrix-rust-sdk {}", crate::VERSION)) .expect("Can't construct the version header"), }; headers.insert(reqwest::header::USER_AGENT, user_agent); http_client.default_headers(headers).timeout(config.request_config.timeout) }; #[cfg(target_arch = "wasm32")] #[allow(unused)] let _ = config; Ok(http_client.build()?) } async fn response_to_http_response( mut response: Response, ) -> Result, reqwest::Error> { let status = response.status(); let mut http_builder = HttpResponse::builder().status(status); let headers = http_builder.headers_mut().expect("Can't get the response builder headers"); for (k, v) in response.headers_mut().drain() { if let Some(key) = k { headers.insert(key, v); } } let body = response.bytes().await?; Ok(http_builder.body(body).expect("Can't construct a response using the given body")) } #[cfg(any(target_arch = "wasm32"))] async fn send_request( client: &Client, request: http::Request, _: RequestConfig, ) -> Result, HttpError> { let request = reqwest::Request::try_from(request)?; let response = client.execute(request).await?; Ok(response_to_http_response(response).await?) } #[cfg(all(not(target_arch = "wasm32")))] async fn send_request( client: &Client, request: http::Request, config: RequestConfig, ) -> Result, HttpError> { let mut backoff = ExponentialBackoff::default(); let mut request = reqwest::Request::try_from(request)?; let retry_limit = config.retry_limit; let retry_count = AtomicU64::new(1); *request.timeout_mut() = Some(config.timeout); backoff.max_elapsed_time = config.retry_timeout; let request = &request; let retry_count = &retry_count; let request = || async move { let stop = if let Some(retry_limit) = retry_limit { retry_count.fetch_add(1, Ordering::Relaxed) >= retry_limit } else { false }; // Turn errors into permanent errors when the retry limit is reached let error_type = if stop { RetryError::Permanent } else { RetryError::Transient }; let request = request.try_clone().ok_or(HttpError::UnableToCloneRequest)?; let response = client.execute(request).await.map_err(|e| error_type(HttpError::Reqwest(e)))?; let status_code = response.status(); // TODO TOO_MANY_REQUESTS will have a retry timeout which we should // use. if !stop && (status_code.is_server_error() || response.status() == StatusCode::TOO_MANY_REQUESTS) { return Err(error_type(HttpError::Server(status_code))); } let response = response_to_http_response(response) .await .map_err(|e| RetryError::Permanent(HttpError::Reqwest(e)))?; Ok(response) }; let response = retry(backoff, request).await?; Ok(response) } #[cfg_attr(target_arch = "wasm32", async_trait(?Send))] #[cfg_attr(not(target_arch = "wasm32"), async_trait)] impl HttpSend for Client { async fn send_request( &self, request: http::Request, config: RequestConfig, ) -> Result, HttpError> { send_request(&self, request, config).await } }