1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
use std::sync::Arc; use url::Url; use crate::pool::ConnectionPool; use crate::proxy::Proxy; use crate::request::Request; use crate::resolve::{ArcResolver, StdResolver}; use std::time::Duration; #[cfg(feature = "cookies")] use { crate::cookies::{CookieStoreGuard, CookieTin}, cookie_store::CookieStore, }; /// Accumulates options towards building an [Agent]. #[derive(Debug)] pub struct AgentBuilder { config: AgentConfig, max_idle_connections: usize, max_idle_connections_per_host: usize, /// Cookies saved between requests. /// Invariant: All cookies must have a nonempty domain and path. #[cfg(feature = "cookies")] cookie_store: Option<CookieStore>, resolver: ArcResolver, } /// Config as built by AgentBuilder and then static for the lifetime of the Agent. #[derive(Debug, Clone)] pub(crate) struct AgentConfig { pub proxy: Option<Proxy>, pub timeout_connect: Option<Duration>, pub timeout_read: Option<Duration>, pub timeout_write: Option<Duration>, pub timeout: Option<Duration>, pub redirects: u32, pub user_agent: String, #[cfg(feature = "tls")] pub tls_config: Option<TLSClientConfig>, } /// Agents keep state between requests. /// /// By default, no state, such as cookies, is kept between requests. /// But by creating an agent as entry point for the request, we /// can keep a state. /// /// ``` /// # fn main() -> Result<(), ureq::Error> { /// # ureq::is_test(true); /// let mut agent = ureq::agent(); /// /// agent /// .post("http://example.com/login") /// .call()?; /// /// let secret = agent /// .get("http://example.com/my-protected-page") /// .call()? /// .into_string()?; /// /// println!("Secret is: {}", secret); /// # Ok(()) /// # } /// ``` /// /// Agent uses an inner Arc, so cloning an Agent results in an instance /// that shares the same underlying connection pool and other state. #[derive(Debug, Clone)] pub struct Agent { pub(crate) config: Arc<AgentConfig>, /// Reused agent state for repeated requests from this agent. pub(crate) state: Arc<AgentState>, } /// Container of the state /// /// *Internal API*. #[derive(Debug)] pub(crate) struct AgentState { /// Reused connections between requests. pub(crate) pool: ConnectionPool, /// Cookies saved between requests. /// Invariant: All cookies must have a nonempty domain and path. #[cfg(feature = "cookies")] pub(crate) cookie_tin: CookieTin, pub(crate) resolver: ArcResolver, } impl Agent { /// Creates an Agent with default settings. /// /// Same as `AgentBuilder::new().build()`. pub fn new() -> Self { AgentBuilder::new().build() } /// Make a request with the HTTP verb as a parameter. /// /// This allows making requests with verbs that don't have a dedicated /// method. /// /// If you've got an already-parsed [Url], try [request_url][Agent::request_url]. /// /// ``` /// # fn main() -> Result<(), ureq::Error> { /// # ureq::is_test(true); /// use ureq::Response; /// let agent = ureq::agent(); /// /// let resp: Response = agent /// .request("OPTIONS", "http://example.com/") /// .call()?; /// # Ok(()) /// # } /// ``` pub fn request(&self, method: &str, path: &str) -> Request { Request::new(self.clone(), method.into(), path.into()) } /// Make a request using an already-parsed [Url]. /// /// This is useful if you've got a parsed Url from some other source, or if /// you want to parse the URL and then modify it before making the request. /// If you'd just like to pass a String or a `&str`, try [request][Agent::request]. /// /// ``` /// # fn main() -> Result<(), ureq::Error> { /// # ureq::is_test(true); /// use {url::Url, ureq::Response}; /// let agent = ureq::agent(); /// /// let mut url: Url = "http://example.com/some-page".parse().unwrap(); /// url.set_path("/robots.txt"); /// let resp: Response = agent /// .request_url("GET", &url) /// .call()?; /// # Ok(()) /// # } /// ``` pub fn request_url(&self, method: &str, url: &Url) -> Request { Request::with_url(self.clone(), method.into(), url.clone()) } /// Make a GET request from this agent. pub fn get(&self, path: &str) -> Request { self.request("GET", path) } /// Make a HEAD request from this agent. pub fn head(&self, path: &str) -> Request { self.request("HEAD", path) } /// Make a POST request from this agent. pub fn post(&self, path: &str) -> Request { self.request("POST", path) } /// Make a PUT request from this agent. pub fn put(&self, path: &str) -> Request { self.request("PUT", path) } /// Make a DELETE request from this agent. pub fn delete(&self, path: &str) -> Request { self.request("DELETE", path) } /// Read access to the cookie store. /// /// Used to persist the cookies to an external writer. /// /// ```no_run /// use std::io::Write; /// use std::fs::File; /// /// # fn main() -> Result<(), ureq::Error> { /// # ureq::is_test(true); /// let agent = ureq::agent(); /// /// // Cookies set by www.google.com are stored in agent. /// agent.get("https://www.google.com/").call()?; /// /// // Saves (persistent) cookies /// let mut file = File::create("cookies.json")?; /// agent.cookie_store().save_json(&mut file).unwrap(); /// # Ok(()) /// # } /// ``` #[cfg(feature = "cookies")] pub fn cookie_store(&self) -> CookieStoreGuard<'_> { self.state.cookie_tin.read_lock() } } const DEFAULT_MAX_IDLE_CONNECTIONS: usize = 100; const DEFAULT_MAX_IDLE_CONNECTIONS_PER_HOST: usize = 1; impl AgentBuilder { pub fn new() -> Self { AgentBuilder { config: AgentConfig { proxy: None, timeout_connect: Some(Duration::from_secs(30)), timeout_read: None, timeout_write: None, timeout: None, redirects: 5, user_agent: format!("ureq/{}", env!("CARGO_PKG_VERSION")), #[cfg(feature = "tls")] tls_config: None, }, max_idle_connections: DEFAULT_MAX_IDLE_CONNECTIONS, max_idle_connections_per_host: DEFAULT_MAX_IDLE_CONNECTIONS_PER_HOST, resolver: StdResolver.into(), #[cfg(feature = "cookies")] cookie_store: None, } } /// Create a new agent. // Note: This could take &self as the first argument, allowing one // AgentBuilder to be used multiple times, except CookieStore does // not implement clone, so we have to give ownership to the newly // built Agent. pub fn build(self) -> Agent { Agent { config: Arc::new(self.config), state: Arc::new(AgentState { pool: ConnectionPool::new_with_limits( self.max_idle_connections, self.max_idle_connections_per_host, ), #[cfg(feature = "cookies")] cookie_tin: CookieTin::new( self.cookie_store.unwrap_or_else(|| CookieStore::default()), ), resolver: self.resolver, }), } } /// Set the proxy server to use for all connections from this Agent. /// /// Example: /// ``` /// # fn main() -> Result<(), ureq::Error> { /// # ureq::is_test(true); /// let proxy = ureq::Proxy::new("user:password@cool.proxy:9090")?; /// let agent = ureq::AgentBuilder::new() /// .proxy(proxy) /// .build(); /// # Ok(()) /// # } /// ``` pub fn proxy(mut self, proxy: Proxy) -> Self { self.config.proxy = Some(proxy); self } /// Sets the maximum number of connections allowed in the connection pool. /// By default, this is set to 100. Setting this to zero would disable /// connection pooling. /// /// ``` /// let agent = ureq::AgentBuilder::new() /// .max_idle_connections(200) /// .build(); /// ``` pub fn max_idle_connections(mut self, max: usize) -> Self { self.max_idle_connections = max; self } /// Sets the maximum number of connections per host to keep in the /// connection pool. By default, this is set to 1. Setting this to zero /// would disable connection pooling. /// /// ``` /// let agent = ureq::AgentBuilder::new() /// .max_idle_connections_per_host(200) /// .build(); /// ``` pub fn max_idle_connections_per_host(mut self, max: usize) -> Self { self.max_idle_connections_per_host = max; self } /// Configures a custom resolver to be used by this agent. By default, /// address-resolution is done by std::net::ToSocketAddrs. This allows you /// to override that resolution with your own alternative. Useful for /// testing and special-cases like DNS-based load balancing. /// /// A `Fn(&str) -> io::Result<Vec<SocketAddr>>` is a valid resolver, /// passing a closure is a simple way to override. Note that you might need /// explicit type `&str` on the closure argument for type inference to /// succeed. /// ``` /// use std::net::ToSocketAddrs; /// /// let mut agent = ureq::AgentBuilder::new() /// .resolver(|addr: &str| match addr { /// "example.com" => Ok(vec![([127,0,0,1], 8096).into()]), /// addr => addr.to_socket_addrs().map(Iterator::collect), /// }) /// .build(); /// ``` pub fn resolver(mut self, resolver: impl crate::Resolver + 'static) -> Self { self.resolver = resolver.into(); self } /// Timeout for the socket connection to be successful. /// If both this and `.timeout()` are both set, `.timeout_connect()` /// takes precedence. /// /// The default is 30 seconds. /// /// ``` /// use std::time::Duration; /// # fn main() -> Result<(), ureq::Error> { /// # ureq::is_test(true); /// let agent = ureq::builder() /// .timeout_connect(Duration::from_secs(1)) /// .build(); /// let result = agent.get("http://httpbin.org/delay/20").call(); /// # Ok(()) /// # } /// ``` pub fn timeout_connect(mut self, timeout: Duration) -> Self { self.config.timeout_connect = Some(timeout); self } /// Timeout for the individual reads of the socket. /// If both this and `.timeout()` are both set, `.timeout()` /// takes precedence. /// /// The default is no timeout. In other words, requests may block forever on reads by default. /// /// ``` /// use std::time::Duration; /// # fn main() -> Result<(), ureq::Error> { /// # ureq::is_test(true); /// let agent = ureq::builder() /// .timeout_read(Duration::from_secs(1)) /// .build(); /// let result = agent.get("http://httpbin.org/delay/20").call(); /// # Ok(()) /// # } /// ``` pub fn timeout_read(mut self, timeout: Duration) -> Self { self.config.timeout_read = Some(timeout); self } /// Timeout for the individual writes to the socket. /// If both this and `.timeout()` are both set, `.timeout()` /// takes precedence. /// /// The default is no timeout. In other words, requests may block forever on writes by default. /// /// ``` /// use std::time::Duration; /// # fn main() -> Result<(), ureq::Error> { /// # ureq::is_test(true); /// let agent = ureq::builder() /// .timeout_read(Duration::from_secs(1)) /// .build(); /// let result = agent.get("http://httpbin.org/delay/20").call(); /// # Ok(()) /// # } /// ``` pub fn timeout_write(mut self, timeout: Duration) -> Self { self.config.timeout_write = Some(timeout); self } /// Timeout for the overall request, including DNS resolution, connection /// time, redirects, and reading the response body. Slow DNS resolution /// may cause a request to exceed the timeout, because the DNS request /// cannot be interrupted with the available APIs. /// /// This takes precedence over `.timeout_read()` and `.timeout_write()`, but /// not `.timeout_connect()`. /// /// ``` /// # fn main() -> Result<(), ureq::Error> { /// # ureq::is_test(true); /// // wait max 1 second for whole request to complete. /// let agent = ureq::builder() /// .timeout(std::time::Duration::from_secs(1)) /// .build(); /// let result = agent.get("http://httpbin.org/delay/20").call(); /// # Ok(()) /// # } /// ``` pub fn timeout(mut self, timeout: Duration) -> Self { self.config.timeout = Some(timeout); self } /// How many redirects to follow. /// /// Defaults to `5`. Set to `0` to avoid redirects and instead /// get a response object with the 3xx status code. /// /// If the redirect count hits this limit (and it's > 0), TooManyRedirects is returned. /// /// WARNING: for 307 and 308 redirects, this value is ignored for methods that have a body. /// You must handle 307 redirects yourself when sending a PUT, POST, PATCH, or DELETE request. /// /// ``` /// # fn main() -> Result<(), ureq::Error> { /// # ureq::is_test(true); /// let result = ureq::builder() /// .redirects(1) /// .build() /// # ; /// # let result = ureq::agent() /// .get("http://httpbin.org/status/301") /// .call()?; /// assert_ne!(result.status(), 301); /// /// let result = ureq::post("http://httpbin.org/status/307") /// .send_bytes(b"some data")?; /// assert_eq!(result.status(), 307); /// # Ok(()) /// # } /// ``` pub fn redirects(mut self, n: u32) -> Self { self.config.redirects = n; self } /// The user-agent header to associate with all requests from this agent by default. /// /// Defaults to `ureq/[VERSION]`. You can override the user-agent on an individual request by /// setting the `User-Agent` header when constructing the request. /// /// ``` /// # #[cfg(feature = "json")] /// # fn main() -> Result<(), ureq::Error> { /// # ureq::is_test(true); /// let agent = ureq::builder() /// .user_agent("ferris/1.0") /// .build(); /// /// // Uses agent's header /// let result: serde_json::Value = /// agent.get("http://httpbin.org/headers").call()?.into_json()?; /// assert_eq!(&result["headers"]["User-Agent"], "ferris/1.0"); /// /// // Overrides user-agent set on the agent /// let result: serde_json::Value = agent.get("http://httpbin.org/headers") /// .set("User-Agent", "super-ferris/2.0") /// .call()?.into_json()?; /// assert_eq!(&result["headers"]["User-Agent"], "super-ferris/2.0"); /// # Ok(()) /// # } /// # #[cfg(not(feature = "json"))] /// # fn main() {} /// ``` pub fn user_agent(mut self, user_agent: &str) -> Self { self.config.user_agent = user_agent.into(); self } /// Set the TLS client config to use for the connection. See [`ClientConfig`](https://docs.rs/rustls/latest/rustls/struct.ClientConfig.html). /// /// Example: /// ``` /// # fn main() -> Result<(), ureq::Error> { /// # ureq::is_test(true); /// use std::sync::Arc; /// let tls_config = Arc::new(rustls::ClientConfig::new()); /// let agent = ureq::builder() /// .tls_config(tls_config.clone()) /// .build(); /// # Ok(()) /// # } /// ``` #[cfg(feature = "tls")] pub fn tls_config(mut self, tls_config: Arc<rustls::ClientConfig>) -> Self { self.config.tls_config = Some(TLSClientConfig(tls_config)); self } /// Provide the cookie store to be used for all requests using this agent. /// /// This is useful in two cases. First when there is a need to persist cookies /// to some backing store, and second when there's a need to prepare the agent /// with some pre-existing cookies. /// /// Example /// ```no_run /// # fn main() -> Result<(), ureq::Error> { /// # ureq::is_test(true); /// use cookie_store::CookieStore; /// use std::fs::File; /// use std::io::BufReader; /// let file = File::open("cookies.json")?; /// let read = BufReader::new(file); /// /// // Read persisted cookies from cookies.json /// let my_store = CookieStore::load_json(read).unwrap(); /// /// // Cookies will be used for requests done through agent. /// let agent = ureq::builder() /// .cookie_store(my_store) /// .build(); /// # Ok(()) /// # } /// ``` #[cfg(feature = "cookies")] pub fn cookie_store(mut self, cookie_store: CookieStore) -> Self { self.cookie_store = Some(cookie_store); self } } #[cfg(feature = "tls")] #[derive(Clone)] pub(crate) struct TLSClientConfig(pub(crate) Arc<rustls::ClientConfig>); #[cfg(feature = "tls")] impl std::fmt::Debug for TLSClientConfig { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_struct("TLSClientConfig").finish() } } #[cfg(test)] mod tests { use super::*; ///////////////////// AGENT TESTS ////////////////////////////// #[test] fn agent_implements_send_and_sync() { let _agent: Box<dyn Send> = Box::new(AgentBuilder::new().build()); let _agent: Box<dyn Sync> = Box::new(AgentBuilder::new().build()); } }