use std::fmt::Write as FmtWrite; use std::io::Write; use std::time::Duration; use std::{fmt, mem}; use actix::Addr; use bytes::{BufMut, Bytes, BytesMut}; use cookie::{Cookie, CookieJar}; use futures::Stream; use percent_encoding::{percent_encode, USERINFO_ENCODE_SET}; use serde::Serialize; use serde_json; use serde_urlencoded; use url::Url; use super::connector::{ClientConnector, Connection}; use super::pipeline::SendRequest; use body::Body; use error::Error; use header::{ContentEncoding, Header, IntoHeaderValue}; use http::header::{self, HeaderName, HeaderValue}; use http::{uri, Error as HttpError, HeaderMap, HttpTryFrom, Method, Uri, Version}; use httpmessage::HttpMessage; use httprequest::HttpRequest; /// 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 { uri: Uri, method: Method, version: Version, headers: HeaderMap, body: Body, chunked: bool, upgrade: bool, timeout: Option, encoding: ContentEncoding, response_decompress: bool, buffer_capacity: usize, conn: ConnectionType, } enum ConnectionType { Default, Connector(Addr), Connection(Connection), } impl Default for ClientRequest { fn default() -> ClientRequest { ClientRequest { uri: Uri::default(), method: Method::default(), version: Version::HTTP_11, headers: HeaderMap::with_capacity(16), body: Body::Empty, chunked: false, upgrade: false, timeout: None, encoding: ContentEncoding::Auto, response_decompress: true, buffer_capacity: 32_768, conn: ConnectionType::Default, } } } impl ClientRequest { /// Create request builder for `GET` request pub fn get>(uri: U) -> ClientRequestBuilder { let mut builder = ClientRequest::build(); builder.method(Method::GET).uri(uri); builder } /// Create request builder for `HEAD` request pub fn head>(uri: U) -> ClientRequestBuilder { let mut builder = ClientRequest::build(); builder.method(Method::HEAD).uri(uri); builder } /// Create request builder for `POST` request pub fn post>(uri: U) -> ClientRequestBuilder { let mut builder = ClientRequest::build(); builder.method(Method::POST).uri(uri); builder } /// Create request builder for `PUT` request pub fn put>(uri: U) -> ClientRequestBuilder { let mut builder = ClientRequest::build(); builder.method(Method::PUT).uri(uri); builder } /// Create request builder for `DELETE` request pub fn delete>(uri: U) -> ClientRequestBuilder { let mut builder = ClientRequest::build(); builder.method(Method::DELETE).uri(uri); builder } } impl ClientRequest { /// Create client request builder pub fn build() -> ClientRequestBuilder { ClientRequestBuilder { request: Some(ClientRequest::default()), err: None, cookies: None, default_headers: true, } } /// Create client request builder pub fn build_from>(source: T) -> ClientRequestBuilder { source.into() } /// Get the request URI #[inline] pub fn uri(&self) -> &Uri { &self.uri } /// Set client request URI #[inline] pub fn set_uri(&mut self, uri: Uri) { self.uri = uri } /// Get the request method #[inline] pub fn method(&self) -> &Method { &self.method } /// Set HTTP `Method` for the request #[inline] pub fn set_method(&mut self, method: Method) { self.method = method } /// Get HTTP version for the request #[inline] pub fn version(&self) -> Version { self.version } /// Set http `Version` for the request #[inline] pub fn set_version(&mut self, version: Version) { self.version = version } /// Get the headers from the request #[inline] pub fn headers(&self) -> &HeaderMap { &self.headers } /// Get a mutable reference to the headers #[inline] pub fn headers_mut(&mut self) -> &mut HeaderMap { &mut self.headers } /// is chunked encoding enabled #[inline] pub fn chunked(&self) -> bool { self.chunked } /// is upgrade request #[inline] pub fn upgrade(&self) -> bool { self.upgrade } /// Content encoding #[inline] pub fn content_encoding(&self) -> ContentEncoding { self.encoding } /// Decompress response payload #[inline] pub fn response_decompress(&self) -> bool { self.response_decompress } /// Requested write buffer capacity pub fn write_buffer_capacity(&self) -> usize { self.buffer_capacity } /// Get body of this response #[inline] pub fn body(&self) -> &Body { &self.body } /// Set a body pub fn set_body>(&mut self, body: B) { self.body = body.into(); } /// Extract body, replace it with `Empty` pub(crate) fn replace_body(&mut self, body: Body) -> Body { mem::replace(&mut self.body, body) } /// Send request /// /// This method returns a future that resolves to a ClientResponse pub fn send(mut self) -> SendRequest { let timeout = self.timeout.take(); let send = match mem::replace(&mut self.conn, ConnectionType::Default) { ConnectionType::Default => SendRequest::new(self), ConnectionType::Connector(conn) => SendRequest::with_connector(self, conn), ConnectionType::Connection(conn) => SendRequest::with_connection(self, conn), }; if let Some(timeout) = timeout { send.timeout(timeout) } else { send } } } impl fmt::Debug for ClientRequest { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let res = writeln!( f, "\nClientRequest {:?} {}:{}", self.version, self.method, self.uri ); let _ = writeln!(f, " headers:"); for (key, val) in self.headers.iter() { let _ = writeln!(f, " {:?}: {:?}", key, val); } res } } /// An HTTP Client request builder /// /// This type can be used to construct an instance of `ClientRequest` through a /// builder-like pattern. pub struct ClientRequestBuilder { request: 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 { match Url::parse(uri.as_ref()) { Ok(url) => self._uri(url.as_str()), Err(_) => self._uri(uri.as_ref()), } } fn _uri(&mut self, url: &str) -> &mut Self { match Uri::try_from(url) { Ok(uri) => { // set request host header if let Some(host) = uri.host() { self.set_header(header::HOST, host); } if let Some(parts) = parts(&mut self.request, &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.request, &self.err) { parts.method = method; } self } /// Set HTTP method of this request. #[inline] pub fn get_method(&mut self) -> &Method { let parts = parts(&mut self.request, &self.err).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.request, &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.request, &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.request, &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.request, &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.request, &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 } /// Set content encoding. /// /// By default `ContentEncoding::Identity` is used. #[inline] pub fn content_encoding(&mut self, enc: ContentEncoding) -> &mut Self { if let Some(parts) = parts(&mut self.request, &self.err) { parts.encoding = enc; } self } /// Enables automatic chunked transfer encoding #[inline] pub fn chunked(&mut self) -> &mut Self { if let Some(parts) = parts(&mut self.request, &self.err) { parts.chunked = true; } self } /// Enable connection upgrade #[inline] pub fn upgrade(&mut self) -> &mut Self { if let Some(parts) = parts(&mut self.request, &self.err) { parts.upgrade = true; } 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.request, &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 } /// Disable automatic decompress response body pub fn disable_decompress(&mut self) -> &mut Self { if let Some(parts) = parts(&mut self.request, &self.err) { parts.response_decompress = false; } self } /// Set write buffer capacity /// /// Default buffer capacity is 32kb pub fn write_buffer_capacity(&mut self, cap: usize) -> &mut Self { if let Some(parts) = parts(&mut self.request, &self.err) { parts.buffer_capacity = cap; } self } /// Set request timeout /// /// Request timeout is a total time before response should be received. /// Default value is 5 seconds. pub fn timeout(&mut self, timeout: Duration) -> &mut Self { if let Some(parts) = parts(&mut self.request, &self.err) { parts.timeout = Some(timeout); } self } /// Send request using custom connector pub fn with_connector(&mut self, conn: Addr) -> &mut Self { if let Some(parts) = parts(&mut self.request, &self.err) { parts.conn = ConnectionType::Connector(conn); } self } /// Send request using existing `Connection` pub fn with_connection(&mut self, conn: Connection) -> &mut Self { if let Some(parts) = parts(&mut self.request, &self.err) { parts.conn = ConnectionType::Connection(conn); } 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 { if let Some(e) = self.err.take() { return Err(e.into()); } if self.default_headers { // enable br only for https let https = if let Some(parts) = parts(&mut self.request, &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"); } self.set_header_if_none( header::USER_AGENT, concat!("Actix-web/", env!("CARGO_PKG_VERSION")), ); } let mut request = self.request.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); } request.headers.insert( header::COOKIE, HeaderValue::from_str(&cookie.as_str()[2..]).unwrap(), ); } request.body = body.into(); Ok(request) } /// Set a JSON body and generate `ClientRequest` /// /// `ClientRequestBuilder` can not be used after this call. pub fn json(&mut self, value: T) -> Result { let body = serde_json::to_string(&value)?; let contains = if let Some(parts) = parts(&mut self.request, &self.err) { parts.headers.contains_key(header::CONTENT_TYPE) } else { true }; if !contains { self.header(header::CONTENT_TYPE, "application/json"); } self.body(body) } /// Set a urlencoded body and generate `ClientRequest` /// /// `ClientRequestBuilder` can not be used after this call. pub fn form(&mut self, value: T) -> Result { let body = serde_urlencoded::to_string(&value)?; let contains = if let Some(parts) = parts(&mut self.request, &self.err) { parts.headers.contains_key(header::CONTENT_TYPE) } else { true }; if !contains { self.header(header::CONTENT_TYPE, "application/x-www-form-urlencoded"); } self.body(body) } /// Set a streaming body and generate `ClientRequest`. /// /// `ClientRequestBuilder` can not be used after this call. pub fn streaming(&mut self, stream: S) -> Result where S: Stream + 'static, E: Into, { self.body(Body::Streaming(Box::new(stream.map_err(|e| e.into())))) } /// Set an empty body and generate `ClientRequest` /// /// `ClientRequestBuilder` can not be used after this call. pub fn finish(&mut self) -> Result { self.body(Body::Empty) } /// This method construct new `ClientRequestBuilder` pub fn take(&mut self) -> ClientRequestBuilder { ClientRequestBuilder { request: self.request.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 ClientRequest> { 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.request { let res = writeln!( f, "\nClientRequestBuilder {:?} {}:{}", parts.version, parts.method, parts.uri ); let _ = writeln!(f, " headers:"); for (key, val) in parts.headers.iter() { let _ = writeln!(f, " {:?}: {:?}", key, val); } res } else { write!(f, "ClientRequestBuilder(Consumed)") } } } /// Create `ClientRequestBuilder` from `HttpRequest` /// /// It is useful for proxy requests. This implementation /// copies all request headers and the method. impl<'a, S: 'static> From<&'a HttpRequest> for ClientRequestBuilder { fn from(req: &'a HttpRequest) -> ClientRequestBuilder { let mut builder = ClientRequest::build(); for (key, value) in req.headers() { builder.header(key.clone(), value.clone()); } builder.method(req.method().clone()); builder } }