use std::fmt; use std::fmt::Write as FmtWrite; use std::io::Write; use actix_net::service::Service; use bytes::{BufMut, Bytes, BytesMut}; use cookie::{Cookie, CookieJar}; use futures::{Future, Stream}; use percent_encoding::{percent_encode, USERINFO_ENCODE_SET}; use crate::body::{BodyStream, MessageBody}; use crate::error::Error; use crate::header::{self, Header, IntoHeaderValue}; use crate::http::{ uri, Error as HttpError, HeaderMap, HeaderName, HeaderValue, HttpTryFrom, Method, Uri, Version, }; use crate::message::{ConnectionType, Head, RequestHead}; use super::response::ClientResponse; use super::{pipeline, Connect, Connection, ConnectorError, SendRequestError}; /// An HTTP Client Request /// /// ```rust /// # extern crate actix_web; /// # extern crate futures; /// # extern crate tokio; /// # use futures::Future; /// # use std::process; /// use actix_web::{actix, client}; /// /// fn main() { /// actix::run( /// || client::ClientRequest::get("http://www.rust-lang.org") // <- Create request builder /// .header("User-Agent", "Actix-web") /// .finish().unwrap() /// .send() // <- Send http request /// .map_err(|_| ()) /// .and_then(|response| { // <- server http response /// println!("Response: {:?}", response); /// # actix::System::current().stop(); /// Ok(()) /// }), /// ); /// } /// ``` pub struct ClientRequest { head: RequestHead, body: B, } impl ClientRequest<()> { /// Create client request builder pub fn build() -> ClientRequestBuilder { ClientRequestBuilder { head: Some(RequestHead::default()), err: None, cookies: None, default_headers: true, } } /// Create request builder for `GET` request pub fn get(uri: U) -> ClientRequestBuilder where Uri: HttpTryFrom, { let mut builder = ClientRequest::build(); builder.method(Method::GET).uri(uri); builder } /// Create request builder for `HEAD` request pub fn head(uri: U) -> ClientRequestBuilder where Uri: HttpTryFrom, { let mut builder = ClientRequest::build(); builder.method(Method::HEAD).uri(uri); builder } /// Create request builder for `POST` request pub fn post(uri: U) -> ClientRequestBuilder where Uri: HttpTryFrom, { let mut builder = ClientRequest::build(); builder.method(Method::POST).uri(uri); builder } /// Create request builder for `PUT` request pub fn put(uri: U) -> ClientRequestBuilder where Uri: HttpTryFrom, { let mut builder = ClientRequest::build(); builder.method(Method::PUT).uri(uri); builder } /// Create request builder for `DELETE` request pub fn delete(uri: U) -> ClientRequestBuilder where Uri: HttpTryFrom, { let mut builder = ClientRequest::build(); builder.method(Method::DELETE).uri(uri); builder } } impl ClientRequest where B: MessageBody, { /// Get the request URI #[inline] pub fn uri(&self) -> &Uri { &self.head.uri } /// Set client request URI #[inline] pub fn set_uri(&mut self, uri: Uri) { self.head.uri = uri } /// Get the request method #[inline] pub fn method(&self) -> &Method { &self.head.method } /// Set HTTP `Method` for the request #[inline] pub fn set_method(&mut self, method: Method) { self.head.method = method } /// Get HTTP version for the request #[inline] pub fn version(&self) -> Version { self.head.version } /// Set http `Version` for the request #[inline] pub fn set_version(&mut self, version: Version) { self.head.version = version } /// Get the headers from the request #[inline] pub fn headers(&self) -> &HeaderMap { &self.head.headers } /// Get a mutable reference to the headers #[inline] pub fn headers_mut(&mut self) -> &mut HeaderMap { &mut self.head.headers } /// Deconstruct ClientRequest to a RequestHead and body tuple pub fn into_parts(self) -> (RequestHead, B) { (self.head, self.body) } // Send request /// /// This method returns a future that resolves to a ClientResponse pub fn send( self, connector: &mut T, ) -> impl Future where T: Service, I: Connection, { pipeline::send_request(self.head, self.body, connector) } } impl fmt::Debug for ClientRequest where B: MessageBody, { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { writeln!( f, "\nClientRequest {:?} {}:{}", self.head.version, self.head.method, self.head.uri )?; writeln!(f, " headers:")?; for (key, val) in self.head.headers.iter() { writeln!(f, " {:?}: {:?}", key, val)?; } Ok(()) } } /// An HTTP Client request builder /// /// This type can be used to construct an instance of `ClientRequest` through a /// builder-like pattern. pub struct ClientRequestBuilder { head: Option, err: Option, cookies: Option, default_headers: bool, } impl ClientRequestBuilder { /// Set HTTP URI of request. #[inline] pub fn uri(&mut self, uri: U) -> &mut Self where Uri: HttpTryFrom, { match Uri::try_from(uri) { Ok(uri) => { if let Some(parts) = parts(&mut self.head, &self.err) { parts.uri = uri; } } Err(e) => self.err = Some(e.into()), } self } /// Set HTTP method of this request. #[inline] pub fn method(&mut self, method: Method) -> &mut Self { if let Some(parts) = parts(&mut self.head, &self.err) { parts.method = method; } self } /// Set HTTP method of this request. #[inline] pub fn get_method(&mut self) -> &Method { let parts = self.head.as_ref().expect("cannot reuse request builder"); &parts.method } /// Set HTTP version of this request. /// /// By default requests's HTTP version depends on network stream #[inline] pub fn version(&mut self, version: Version) -> &mut Self { if let Some(parts) = parts(&mut self.head, &self.err) { parts.version = version; } self } /// Set a header. /// /// ```rust /// # extern crate mime; /// # extern crate actix_web; /// # use actix_web::client::*; /// # /// use actix_web::{client, http}; /// /// fn main() { /// let req = client::ClientRequest::build() /// .set(http::header::Date::now()) /// .set(http::header::ContentType(mime::TEXT_HTML)) /// .finish() /// .unwrap(); /// } /// ``` #[doc(hidden)] pub fn set(&mut self, hdr: H) -> &mut Self { if let Some(parts) = parts(&mut self.head, &self.err) { match hdr.try_into() { Ok(value) => { parts.headers.insert(H::name(), value); } Err(e) => self.err = Some(e.into()), } } self } /// Append a header. /// /// Header gets appended to existing header. /// To override header use `set_header()` method. /// /// ```rust /// # extern crate http; /// # extern crate actix_web; /// # use actix_web::client::*; /// # /// use http::header; /// /// fn main() { /// let req = ClientRequest::build() /// .header("X-TEST", "value") /// .header(header::CONTENT_TYPE, "application/json") /// .finish() /// .unwrap(); /// } /// ``` pub fn header(&mut self, key: K, value: V) -> &mut Self where HeaderName: HttpTryFrom, V: IntoHeaderValue, { if let Some(parts) = parts(&mut self.head, &self.err) { match HeaderName::try_from(key) { Ok(key) => match value.try_into() { Ok(value) => { parts.headers.append(key, value); } Err(e) => self.err = Some(e.into()), }, Err(e) => self.err = Some(e.into()), }; } self } /// Set a header. pub fn set_header(&mut self, key: K, value: V) -> &mut Self where HeaderName: HttpTryFrom, V: IntoHeaderValue, { if let Some(parts) = parts(&mut self.head, &self.err) { match HeaderName::try_from(key) { Ok(key) => match value.try_into() { Ok(value) => { parts.headers.insert(key, value); } Err(e) => self.err = Some(e.into()), }, Err(e) => self.err = Some(e.into()), }; } self } /// Set a header only if it is not yet set. pub fn set_header_if_none(&mut self, key: K, value: V) -> &mut Self where HeaderName: HttpTryFrom, V: IntoHeaderValue, { if let Some(parts) = parts(&mut self.head, &self.err) { match HeaderName::try_from(key) { Ok(key) => { if !parts.headers.contains_key(&key) { match value.try_into() { Ok(value) => { parts.headers.insert(key, value); } Err(e) => self.err = Some(e.into()), } } } Err(e) => self.err = Some(e.into()), }; } self } /// Enable connection upgrade #[inline] pub fn upgrade(&mut self, value: V) -> &mut Self where V: IntoHeaderValue, { { if let Some(parts) = parts(&mut self.head, &self.err) { parts.set_connection_type(ConnectionType::Upgrade); } } self.set_header(header::UPGRADE, value) } /// Close connection #[inline] pub fn close(&mut self) -> &mut Self { if let Some(parts) = parts(&mut self.head, &self.err) { parts.set_connection_type(ConnectionType::Close); } self } /// Set request's content type #[inline] pub fn content_type(&mut self, value: V) -> &mut Self where HeaderValue: HttpTryFrom, { if let Some(parts) = parts(&mut self.head, &self.err) { match HeaderValue::try_from(value) { Ok(value) => { parts.headers.insert(header::CONTENT_TYPE, value); } Err(e) => self.err = Some(e.into()), }; } self } /// Set content length #[inline] pub fn content_length(&mut self, len: u64) -> &mut Self { let mut wrt = BytesMut::new().writer(); let _ = write!(wrt, "{}", len); self.header(header::CONTENT_LENGTH, wrt.get_mut().take().freeze()) } /// Set a cookie /// /// ```rust /// # extern crate actix_web; /// use actix_web::{client, http}; /// /// fn main() { /// let req = client::ClientRequest::build() /// .cookie( /// http::Cookie::build("name", "value") /// .domain("www.rust-lang.org") /// .path("/") /// .secure(true) /// .http_only(true) /// .finish(), /// ) /// .finish() /// .unwrap(); /// } /// ``` pub fn cookie<'c>(&mut self, cookie: Cookie<'c>) -> &mut Self { if self.cookies.is_none() { let mut jar = CookieJar::new(); jar.add(cookie.into_owned()); self.cookies = Some(jar) } else { self.cookies.as_mut().unwrap().add(cookie.into_owned()); } self } /// Do not add default request headers. /// By default `Accept-Encoding` and `User-Agent` headers are set. pub fn no_default_headers(&mut self) -> &mut Self { self.default_headers = false; self } /// This method calls provided closure with builder reference if /// value is `true`. pub fn if_true(&mut self, value: bool, f: F) -> &mut Self where F: FnOnce(&mut ClientRequestBuilder), { if value { f(self); } self } /// This method calls provided closure with builder reference if /// value is `Some`. pub fn if_some(&mut self, value: Option, f: F) -> &mut Self where F: FnOnce(T, &mut ClientRequestBuilder), { if let Some(val) = value { f(val, self); } self } /// Set a body and generate `ClientRequest`. /// /// `ClientRequestBuilder` can not be used after this call. pub fn body( &mut self, body: B, ) -> Result, HttpError> { if let Some(e) = self.err.take() { return Err(e); } if self.default_headers { // enable br only for https let https = if let Some(parts) = parts(&mut self.head, &self.err) { parts .uri .scheme_part() .map(|s| s == &uri::Scheme::HTTPS) .unwrap_or(true) } else { true }; if https { self.set_header_if_none(header::ACCEPT_ENCODING, "br, gzip, deflate"); } else { self.set_header_if_none(header::ACCEPT_ENCODING, "gzip, deflate"); } // set request host header if let Some(parts) = parts(&mut self.head, &self.err) { if let Some(host) = parts.uri.host() { if !parts.headers.contains_key(header::HOST) { let mut wrt = BytesMut::with_capacity(host.len() + 5).writer(); let _ = match parts.uri.port() { None | Some(80) | Some(443) => write!(wrt, "{}", host), Some(port) => write!(wrt, "{}:{}", host, port), }; match wrt.get_mut().take().freeze().try_into() { Ok(value) => { parts.headers.insert(header::HOST, value); } Err(e) => self.err = Some(e.into()), } } } } // user agent self.set_header_if_none( header::USER_AGENT, concat!("actix-http/", env!("CARGO_PKG_VERSION")), ); } let mut head = self.head.take().expect("cannot reuse request builder"); // set cookies if let Some(ref mut jar) = self.cookies { let mut cookie = String::new(); for c in jar.delta() { let name = percent_encode(c.name().as_bytes(), USERINFO_ENCODE_SET); let value = percent_encode(c.value().as_bytes(), USERINFO_ENCODE_SET); let _ = write!(&mut cookie, "; {}={}", name, value); } head.headers.insert( header::COOKIE, HeaderValue::from_str(&cookie.as_str()[2..]).unwrap(), ); } Ok(ClientRequest { head, body }) } /// Set an streaming body and generate `ClientRequest`. /// /// `ClientRequestBuilder` can not be used after this call. pub fn stream( &mut self, stream: S, ) -> Result, HttpError> where S: Stream, E: Into + 'static, { self.body(BodyStream::new(stream)) } /// Set an empty body and generate `ClientRequest`. /// /// `ClientRequestBuilder` can not be used after this call. pub fn finish(&mut self) -> Result, HttpError> { self.body(()) } /// This method construct new `ClientRequestBuilder` pub fn take(&mut self) -> ClientRequestBuilder { ClientRequestBuilder { head: self.head.take(), err: self.err.take(), cookies: self.cookies.take(), default_headers: self.default_headers, } } } #[inline] fn parts<'a>( parts: &'a mut Option, err: &Option, ) -> Option<&'a mut RequestHead> { if err.is_some() { return None; } parts.as_mut() } impl fmt::Debug for ClientRequestBuilder { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { if let Some(ref parts) = self.head { writeln!( f, "\nClientRequestBuilder {:?} {}:{}", parts.version, parts.method, parts.uri )?; writeln!(f, " headers:")?; for (key, val) in parts.headers.iter() { writeln!(f, " {:?}: {:?}", key, val)?; } Ok(()) } else { write!(f, "ClientRequestBuilder(Consumed)") } } }