4857a5917d
This adds an implementation to convert a `Response` type from the `http` crate to the `async_impl::Response` type. This is the first step to allow us to convert `http::Response` objects to `request::Response` objects This also adds an extension trait for the `http::response::Builder` type. The `http::Response` object does not provide a way to access the "final" url that the response is derived from, so we can't easily provide that in the `From<http::Response>` implementation. For users who are manually constructing `http::Response` objects for use in tests, etc, they can import this extension trait, which adds a `.url()` builder method that will allow them to pass a `Url`, which we then convert to our newtype'd Url and add to the `http::Response`'s `extensions`. Then, when converting from `http::Response` to `async_impl::Response` we can pull that value out of the `extensions` and use it to construct the `async_impl::Response` Closes #333
527 lines
16 KiB
Rust
527 lines
16 KiB
Rust
use std::fmt;
|
|
use std::sync::Arc;
|
|
use std::time::Duration;
|
|
use std::thread;
|
|
|
|
use futures::{Future, Stream};
|
|
use futures::future::{self, Either};
|
|
use futures::sync::{mpsc, oneshot};
|
|
|
|
use request::{Request, RequestBuilder};
|
|
use response::{self, Response};
|
|
use {async_impl, header, Certificate, Identity, Method, IntoUrl, Proxy, RedirectPolicy, wait};
|
|
|
|
/// A `Client` to make Requests with.
|
|
///
|
|
/// The Client has various configuration values to tweak, but the defaults
|
|
/// are set to what is usually the most commonly desired value.
|
|
///
|
|
/// The `Client` holds a connection pool internally, so it is advised that
|
|
/// you create one and **reuse** it.
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// ```rust
|
|
/// # use reqwest::{Error, Client};
|
|
/// #
|
|
/// # fn run() -> Result<(), Error> {
|
|
/// let client = Client::new();
|
|
/// let resp = client.get("http://httpbin.org/").send()?;
|
|
/// # drop(resp);
|
|
/// # Ok(())
|
|
/// # }
|
|
///
|
|
/// ```
|
|
#[derive(Clone)]
|
|
pub struct Client {
|
|
inner: ClientHandle,
|
|
}
|
|
|
|
/// A `ClientBuilder` can be used to create a `Client` with custom configuration.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```
|
|
/// # fn run() -> Result<(), reqwest::Error> {
|
|
/// use std::time::Duration;
|
|
///
|
|
/// let client = reqwest::Client::builder()
|
|
/// .gzip(true)
|
|
/// .timeout(Duration::from_secs(10))
|
|
/// .build()?;
|
|
/// # Ok(())
|
|
/// # }
|
|
/// ```
|
|
pub struct ClientBuilder {
|
|
inner: async_impl::ClientBuilder,
|
|
timeout: Timeout,
|
|
}
|
|
|
|
impl ClientBuilder {
|
|
/// Constructs a new `ClientBuilder`
|
|
pub fn new() -> ClientBuilder {
|
|
ClientBuilder {
|
|
inner: async_impl::ClientBuilder::new(),
|
|
timeout: Timeout::default(),
|
|
}
|
|
}
|
|
|
|
/// Returns a `Client` that uses this `ClientBuilder` configuration.
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// This method fails if native TLS backend cannot be initialized.
|
|
pub fn build(self) -> ::Result<Client> {
|
|
ClientHandle::new(self).map(|handle| Client {
|
|
inner: handle,
|
|
})
|
|
}
|
|
|
|
/// Add a custom root certificate.
|
|
///
|
|
/// This can be used to connect to a server that has a self-signed
|
|
/// certificate for example.
|
|
///
|
|
/// # Example
|
|
/// ```
|
|
/// # use std::fs::File;
|
|
/// # use std::io::Read;
|
|
/// # fn build_client() -> Result<(), Box<std::error::Error>> {
|
|
/// // read a local binary DER encoded certificate
|
|
/// let mut buf = Vec::new();
|
|
/// File::open("my-cert.der")?.read_to_end(&mut buf)?;
|
|
///
|
|
/// // create a certificate
|
|
/// let cert = reqwest::Certificate::from_der(&buf)?;
|
|
///
|
|
/// // get a client builder
|
|
/// let client = reqwest::Client::builder()
|
|
/// .add_root_certificate(cert)
|
|
/// .build()?;
|
|
/// # drop(client);
|
|
/// # Ok(())
|
|
/// # }
|
|
/// ```
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// This method fails if adding root certificate was unsuccessful.
|
|
pub fn add_root_certificate(self, cert: Certificate) -> ClientBuilder {
|
|
self.with_inner(move |inner| inner.add_root_certificate(cert))
|
|
}
|
|
|
|
/// Sets the identity to be used for client certificate authentication.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```
|
|
/// # use std::fs::File;
|
|
/// # use std::io::Read;
|
|
/// # fn build_client() -> Result<(), Box<std::error::Error>> {
|
|
/// // read a local PKCS12 bundle
|
|
/// let mut buf = Vec::new();
|
|
/// File::open("my-ident.pfx")?.read_to_end(&mut buf)?;
|
|
///
|
|
/// // create an Identity from the PKCS#12 archive
|
|
/// let pkcs12 = reqwest::Identity::from_pkcs12_der(&buf, "my-privkey-password")?;
|
|
///
|
|
/// // get a client builder
|
|
/// let client = reqwest::Client::builder()
|
|
/// .identity(pkcs12)
|
|
/// .build()?;
|
|
/// # drop(client);
|
|
/// # Ok(())
|
|
/// # }
|
|
/// ```
|
|
pub fn identity(self, identity: Identity) -> ClientBuilder {
|
|
self.with_inner(move |inner| inner.identity(identity))
|
|
}
|
|
|
|
|
|
/// Controls the use of hostname verification.
|
|
///
|
|
/// Defaults to `false`.
|
|
///
|
|
/// # Warning
|
|
///
|
|
/// You should think very carefully before you use this method. If
|
|
/// hostname verification is not used, any valid certificate for any
|
|
/// site will be trusted for use from any other. This introduces a
|
|
/// significant vulnerability to man-in-the-middle attacks.
|
|
pub fn danger_accept_invalid_hostnames(self, accept_invalid_hostname: bool) -> ClientBuilder {
|
|
self.with_inner(|inner| inner.danger_accept_invalid_hostnames(accept_invalid_hostname))
|
|
}
|
|
|
|
|
|
/// Controls the use of certificate validation.
|
|
///
|
|
/// Defaults to `false`.
|
|
///
|
|
/// # Warning
|
|
///
|
|
/// You should think very carefully before using this method. If
|
|
/// invalid certificates are trusted, *any* certificate for *any* site
|
|
/// will be trusted for use. This includes expired certificates. This
|
|
/// introduces significant vulnerabilities, and should only be used
|
|
/// as a last resort.
|
|
pub fn danger_accept_invalid_certs(self, accept_invalid_certs: bool) -> ClientBuilder {
|
|
self.with_inner(|inner| inner.danger_accept_invalid_certs(accept_invalid_certs))
|
|
}
|
|
|
|
/// Sets the default headers for every request.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```rust
|
|
/// use reqwest::header;
|
|
/// # fn build_client() -> Result<(), Box<std::error::Error>> {
|
|
/// let mut headers = header::HeaderMap::new();
|
|
/// headers.insert(header::AUTHORIZATION, header::HeaderValue::from_static("secret"));
|
|
///
|
|
/// // get a client builder
|
|
/// let client = reqwest::Client::builder()
|
|
/// .default_headers(headers)
|
|
/// .build()?;
|
|
/// let res = client.get("https://www.rust-lang.org").send()?;
|
|
/// # Ok(())
|
|
/// # }
|
|
/// ```
|
|
///
|
|
/// Override the default headers:
|
|
///
|
|
/// ```rust
|
|
/// use reqwest::header;
|
|
/// # fn build_client() -> Result<(), Box<std::error::Error>> {
|
|
/// let mut headers = header::HeaderMap::new();
|
|
/// headers.insert(header::AUTHORIZATION, header::HeaderValue::from_static("secret"));
|
|
///
|
|
/// // get a client builder
|
|
/// let client = reqwest::Client::builder()
|
|
/// .default_headers(headers)
|
|
/// .build()?;
|
|
/// let res = client
|
|
/// .get("https://www.rust-lang.org")
|
|
/// .header(header::AUTHORIZATION, "token")
|
|
/// .send()?;
|
|
/// # Ok(())
|
|
/// # }
|
|
/// ```
|
|
pub fn default_headers(self, headers: header::HeaderMap) -> ClientBuilder {
|
|
self.with_inner(move |inner| inner.default_headers(headers))
|
|
}
|
|
|
|
/// Enable auto gzip decompression by checking the ContentEncoding response header.
|
|
///
|
|
/// If auto gzip decompresson is turned on:
|
|
/// - When sending a request and if the request's headers do not already contain
|
|
/// an `Accept-Encoding` **and** `Range` values, the `Accept-Encoding` header is set to `gzip`.
|
|
/// The body is **not** automatically inflated.
|
|
/// - When receiving a response, if it's headers contain a `Content-Encoding` value that
|
|
/// equals to `gzip`, both values `Content-Encoding` and `Content-Length` are removed from the
|
|
/// headers' set. The body is automatically deinflated.
|
|
///
|
|
/// Default is enabled.
|
|
pub fn gzip(self, enable: bool) -> ClientBuilder {
|
|
self.with_inner(|inner| inner.gzip(enable))
|
|
}
|
|
|
|
/// Add a `Proxy` to the list of proxies the `Client` will use.
|
|
pub fn proxy(self, proxy: Proxy) -> ClientBuilder {
|
|
self.with_inner(move |inner| inner.proxy(proxy))
|
|
}
|
|
|
|
/// Set a `RedirectPolicy` for this client.
|
|
///
|
|
/// Default will follow redirects up to a maximum of 10.
|
|
pub fn redirect(self, policy: RedirectPolicy) -> ClientBuilder {
|
|
self.with_inner(move |inner| inner.redirect(policy))
|
|
}
|
|
|
|
/// Enable or disable automatic setting of the `Referer` header.
|
|
///
|
|
/// Default is `true`.
|
|
pub fn referer(self, enable: bool) -> ClientBuilder {
|
|
self.with_inner(|inner| inner.referer(enable))
|
|
}
|
|
|
|
/// Set a timeout for connect, read and write operations of a `Client`.
|
|
///
|
|
/// Default is 30 seconds.
|
|
///
|
|
/// Pass `None` to disable timeout.
|
|
pub fn timeout<T>(mut self, timeout: T) -> ClientBuilder
|
|
where T: Into<Option<Duration>>,
|
|
{
|
|
self.timeout = Timeout(timeout.into());
|
|
self
|
|
}
|
|
|
|
fn with_inner<F>(mut self, func: F) -> ClientBuilder
|
|
where
|
|
F: FnOnce(async_impl::ClientBuilder) -> async_impl::ClientBuilder,
|
|
{
|
|
self.inner = func(self.inner);
|
|
self
|
|
}
|
|
}
|
|
|
|
|
|
impl Client {
|
|
/// Constructs a new `Client`.
|
|
///
|
|
/// # Panic
|
|
///
|
|
/// This method panics if native TLS backend cannot be created or
|
|
/// initialized. Use `Client::builder()` if you wish to handle the failure
|
|
/// as an `Error` instead of panicking.
|
|
pub fn new() -> Client {
|
|
ClientBuilder::new()
|
|
.build()
|
|
.expect("Client failed to initialize")
|
|
}
|
|
|
|
/// Creates a `ClientBuilder` to configure a `Client`.
|
|
pub fn builder() -> ClientBuilder {
|
|
ClientBuilder::new()
|
|
}
|
|
|
|
/// Convenience method to make a `GET` request to a URL.
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// This method fails whenever supplied `Url` cannot be parsed.
|
|
pub fn get<U: IntoUrl>(&self, url: U) -> RequestBuilder {
|
|
self.request(Method::GET, url)
|
|
}
|
|
|
|
/// Convenience method to make a `POST` request to a URL.
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// This method fails whenever supplied `Url` cannot be parsed.
|
|
pub fn post<U: IntoUrl>(&self, url: U) -> RequestBuilder {
|
|
self.request(Method::POST, url)
|
|
}
|
|
|
|
/// Convenience method to make a `PUT` request to a URL.
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// This method fails whenever supplied `Url` cannot be parsed.
|
|
pub fn put<U: IntoUrl>(&self, url: U) -> RequestBuilder {
|
|
self.request(Method::PUT, url)
|
|
}
|
|
|
|
/// Convenience method to make a `PATCH` request to a URL.
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// This method fails whenever supplied `Url` cannot be parsed.
|
|
pub fn patch<U: IntoUrl>(&self, url: U) -> RequestBuilder {
|
|
self.request(Method::PATCH, url)
|
|
}
|
|
|
|
/// Convenience method to make a `DELETE` request to a URL.
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// This method fails whenever supplied `Url` cannot be parsed.
|
|
pub fn delete<U: IntoUrl>(&self, url: U) -> RequestBuilder {
|
|
self.request(Method::DELETE, url)
|
|
}
|
|
|
|
/// Convenience method to make a `HEAD` request to a URL.
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// This method fails whenever supplied `Url` cannot be parsed.
|
|
pub fn head<U: IntoUrl>(&self, url: U) -> RequestBuilder {
|
|
self.request(Method::HEAD, url)
|
|
}
|
|
|
|
/// Start building a `Request` with the `Method` and `Url`.
|
|
///
|
|
/// Returns a `RequestBuilder`, which will allow setting headers and
|
|
/// request body before sending.
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// This method fails whenever supplied `Url` cannot be parsed.
|
|
pub fn request<U: IntoUrl>(&self, method: Method, url: U) -> RequestBuilder {
|
|
let req = url
|
|
.into_url()
|
|
.map(move |url| Request::new(method, url));
|
|
RequestBuilder::new(self.clone(), req)
|
|
}
|
|
|
|
/// Executes a `Request`.
|
|
///
|
|
/// A `Request` can be built manually with `Request::new()` or obtained
|
|
/// from a RequestBuilder with `RequestBuilder::build()`.
|
|
///
|
|
/// You should prefer to use the `RequestBuilder` and
|
|
/// `RequestBuilder::send()`.
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// This method fails if there was an error while sending request,
|
|
/// redirect loop was detected or redirect limit was exhausted.
|
|
pub fn execute(&self, request: Request) -> ::Result<Response> {
|
|
self.inner.execute_request(request)
|
|
}
|
|
}
|
|
|
|
impl fmt::Debug for Client {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
f.debug_struct("Client")
|
|
//.field("gzip", &self.inner.gzip)
|
|
//.field("redirect_policy", &self.inner.redirect_policy)
|
|
//.field("referer", &self.inner.referer)
|
|
.finish()
|
|
}
|
|
}
|
|
|
|
impl fmt::Debug for ClientBuilder {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
f.debug_struct("ClientBuilder")
|
|
.finish()
|
|
}
|
|
}
|
|
|
|
#[derive(Clone)]
|
|
struct ClientHandle {
|
|
timeout: Timeout,
|
|
inner: Arc<InnerClientHandle>
|
|
}
|
|
|
|
type ThreadSender = mpsc::UnboundedSender<(async_impl::Request, oneshot::Sender<::Result<async_impl::Response>>)>;
|
|
|
|
struct InnerClientHandle {
|
|
tx: Option<ThreadSender>,
|
|
thread: Option<thread::JoinHandle<()>>
|
|
}
|
|
|
|
impl Drop for InnerClientHandle {
|
|
fn drop(&mut self) {
|
|
self.tx.take();
|
|
self.thread.take().map(|h| h.join());
|
|
}
|
|
}
|
|
|
|
impl ClientHandle {
|
|
fn new(builder: ClientBuilder) -> ::Result<ClientHandle> {
|
|
let timeout = builder.timeout;
|
|
let builder = builder.inner;
|
|
let (tx, rx) = mpsc::unbounded();
|
|
let (spawn_tx, spawn_rx) = oneshot::channel::<::Result<()>>();
|
|
let handle = try_!(thread::Builder::new().name("reqwest-internal-sync-runtime".into()).spawn(move || {
|
|
use tokio::runtime::current_thread::Runtime;
|
|
|
|
let built = (|| {
|
|
let rt = try_!(Runtime::new());
|
|
let client = builder.build()?;
|
|
Ok((rt, client))
|
|
})();
|
|
|
|
let (mut rt, client) = match built {
|
|
Ok((rt, c)) => {
|
|
if let Err(_) = spawn_tx.send(Ok(())) {
|
|
return;
|
|
}
|
|
(rt, c)
|
|
},
|
|
Err(e) => {
|
|
let _ = spawn_tx.send(Err(e));
|
|
return;
|
|
}
|
|
};
|
|
|
|
let work = rx.for_each(move |(req, tx)| {
|
|
let tx: oneshot::Sender<::Result<async_impl::Response>> = tx;
|
|
let task = client.execute(req)
|
|
.then(move |x| tx.send(x).map_err(|_| ()));
|
|
::tokio::spawn(task);
|
|
Ok(())
|
|
});
|
|
|
|
|
|
// work is Future<(), ()>, and our closure will never return Err
|
|
rt.block_on(work)
|
|
.expect("runtime unexpected error");
|
|
}));
|
|
|
|
wait::timeout(spawn_rx, timeout.0).expect("runtime thread cancelled")?;
|
|
|
|
let inner_handle = Arc::new(InnerClientHandle {
|
|
tx: Some(tx),
|
|
thread: Some(handle)
|
|
});
|
|
|
|
|
|
Ok(ClientHandle {
|
|
timeout: timeout,
|
|
inner: inner_handle,
|
|
})
|
|
}
|
|
|
|
fn execute_request(&self, req: Request) -> ::Result<Response> {
|
|
let (tx, rx) = oneshot::channel();
|
|
let (req, body) = req.into_async();
|
|
let url = req.url().clone();
|
|
self.inner.tx
|
|
.as_ref()
|
|
.expect("core thread exited early")
|
|
.unbounded_send((req, tx))
|
|
.expect("core thread panicked");
|
|
|
|
let write = if let Some(body) = body {
|
|
Either::A(body.send())
|
|
//try_!(body.send(self.timeout.0), &url);
|
|
} else {
|
|
Either::B(future::ok(()))
|
|
};
|
|
|
|
let rx = rx.map_err(|_canceled| {
|
|
// The only possible reason there would be a Canceled error
|
|
// is if the thread running the event loop panicked. We could return
|
|
// an Err here, like a BrokenPipe, but the Client is not
|
|
// recoverable. Additionally, the panic in the other thread
|
|
// is not normal, and should likely be propagated.
|
|
panic!("event loop thread panicked");
|
|
});
|
|
|
|
let fut = write.join(rx).map(|((), res)| res);
|
|
|
|
let res = match wait::timeout(fut, self.timeout.0) {
|
|
Ok(res) => res,
|
|
Err(wait::Waited::TimedOut) => return Err(::error::timedout(Some(url))),
|
|
Err(wait::Waited::Err(err)) => {
|
|
return Err(err.with_url(url));
|
|
}
|
|
};
|
|
res.map(|res| {
|
|
response::new(res, self.timeout.0, KeepCoreThreadAlive(Some(self.inner.clone())))
|
|
})
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Copy)]
|
|
struct Timeout(Option<Duration>);
|
|
|
|
impl Default for Timeout {
|
|
fn default() -> Timeout {
|
|
// default mentioned in ClientBuilder::timeout() doc comment
|
|
Timeout(Some(Duration::from_secs(30)))
|
|
}
|
|
}
|
|
|
|
// pub(crate)
|
|
|
|
pub struct KeepCoreThreadAlive(Option<Arc<InnerClientHandle>>);
|
|
|
|
impl KeepCoreThreadAlive {
|
|
pub(crate) fn empty() -> KeepCoreThreadAlive {
|
|
KeepCoreThreadAlive(None)
|
|
}
|
|
}
|