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
use qstring::QString; use std::io::Read; use std::sync::Arc; #[cfg(feature = "json")] use super::SerdeValue; lazy_static! { static ref URL_BASE: Url = { Url::parse("http://localhost/").expect("Failed to parse URL_BASE") }; } /// Request instances are builders that creates a request. /// /// ``` /// let mut request = ureq::get("https://www.google.com/"); /// /// let response = request /// .query("foo", "bar baz") // add ?foo=bar%20baz /// .call(); // run the request /// ``` #[derive(Clone, Default)] pub struct Request { agent: Arc<Mutex<Option<AgentState>>>, // via agent method: String, path: String, // from request itself headers: Vec<Header>, query: QString, timeout_connect: u64, timeout_read: u64, timeout_write: u64, redirects: u32, } impl ::std::fmt::Debug for Request { fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::result::Result<(), ::std::fmt::Error> { let url = self.to_url().unwrap(); let query = combine_query(&url, &self.query); write!( f, "Request({} {}{}, {:?})", self.method, url.path(), query, self.headers ) } } impl Request { fn new(agent: &Agent, method: String, path: String) -> Request { Request { agent: Arc::clone(&agent.state), method, path, headers: agent.headers.clone(), redirects: 5, ..Default::default() } } /// "Builds" this request which is effectively the same as cloning. /// This is needed when we use a chain of request builders, but /// don't want to send the request at the end of the chain. /// /// ``` /// let r = ureq::get("/my_page") /// .set("X-Foo-Bar", "Baz") /// .build(); /// ``` pub fn build(&self) -> Request { self.clone() } /// Executes the request and blocks the caller until done. /// /// Use `.timeout_connect()` and `.timeout_read()` to avoid blocking forever. /// /// ``` /// let r = ureq::get("/my_page") /// .timeout_connect(10_000) // max 10 seconds /// .call(); /// /// println!("{:?}", r); /// ``` pub fn call(&mut self) -> Response { self.do_call(Payload::Empty) } fn do_call(&mut self, payload: Payload) -> Response { self.to_url() .and_then(|url| { let reader = payload.into_read(); let unit = Unit::new(&self, &url, &reader); connect(unit, &self.method, true, self.redirects, reader) }) .unwrap_or_else(|e| e.into()) } /// Send data a json value. /// /// Requires feature `ureq = { version = "*", features = ["json"] }` /// /// The `Content-Length` header is implicitly set to the length of the serialized value. /// /// ``` /// #[macro_use] /// extern crate ureq; /// /// fn main() { /// let r = ureq::post("/my_page") /// .send_json(json!({ "name": "martin", "rust": true })); /// println!("{:?}", r); /// } /// ``` #[cfg(feature = "json")] pub fn send_json(&mut self, data: SerdeValue) -> Response { self.do_call(Payload::JSON(data)) } /// Send data as a string. /// /// The `Content-Length` header is implicitly set to the length of the serialized value. /// Defaults to `utf-8` /// /// ## Charset support /// /// Requires feature `ureq = { version = "*", features = ["charset"] }` /// /// If a `Content-Type` header is present and it contains a charset specification, we /// attempt to encode the string using that character set. If it fails, we fall back /// on utf-8. /// /// ``` /// // this example requires features = ["charset"] /// /// let r = ureq::post("/my_page") /// .set("Content-Type", "text/plain; charset=iso-8859-1") /// .send_string("Hällo Wörld!"); /// println!("{:?}", r); /// ``` pub fn send_string<S>(&mut self, data: S) -> Response where S: Into<String>, { let text = data.into(); let charset = response::charset_from_content_type(self.header("content-type")).to_string(); self.do_call(Payload::Text(text, charset)) } /// Send data from a reader. /// /// The `Content-Length` header is not set because we can't know the length of the reader. /// /// ``` /// use std::io::Cursor; /// /// let text = "Hello there!\n"; /// let read = Cursor::new(text.to_string().into_bytes()); /// /// let resp = ureq::post("/somewhere") /// .set("Content-Type", "text/plain") /// .send(read); /// ``` pub fn send(&mut self, reader: impl Read + 'static) -> Response { self.do_call(Payload::Reader(Box::new(reader))) } /// Set a header field. /// /// ``` /// let r = ureq::get("/my_page") /// .set("X-API-Key", "foobar") /// .set("Accept", "text/plain") /// .call(); /// /// if r.ok() { /// println!("yay got {}", r.into_string().unwrap()); /// } else { /// println!("Oh no error!"); /// } /// ``` pub fn set<K, V>(&mut self, header: K, value: V) -> &mut Request where K: Into<String>, V: Into<String>, { add_header(&mut self.headers, Header::new(&header.into(), &value.into())); self } /// Returns the value for a set header. /// /// ``` /// let req = ureq::get("/my_page") /// .set("X-API-Key", "foobar") /// .build(); /// assert_eq!("foobar", req.header("x-api-Key").unwrap()); /// ``` pub fn header<'a>(&self, name: &'a str) -> Option<&str> { get_header(&self.headers, name) } /// Tells if the header has been set. /// /// ``` /// let req = ureq::get("/my_page") /// .set("X-API-Key", "foobar") /// .build(); /// assert_eq!(true, req.has("x-api-Key")); /// ``` pub fn has<'a>(&self, name: &'a str) -> bool { has_header(&self.headers, name) } /// All headers corresponding values for the give name, or empty vector. /// /// ``` /// let req = ureq::get("/my_page") /// .set("X-Forwarded-For", "1.2.3.4") /// .set("X-Forwarded-For", "2.3.4.5") /// .build(); /// assert_eq!(req.all("x-forwarded-for"), vec![ /// "1.2.3.4", /// "2.3.4.5", /// ]); /// ``` pub fn all<'a>(&self, name: &'a str) -> Vec<&str> { get_all_headers(&self.headers, name) } /// Set many headers. /// /// ``` /// #[macro_use] /// extern crate ureq; /// /// fn main() { /// let r = ureq::get("/my_page") /// .set_map(map! { /// "X-API-Key" => "foobar", /// "Accept" => "text/plain" /// }) /// .call(); /// /// if r.ok() { /// println!("yay got {}", r.into_string().unwrap()); /// } /// } /// ``` pub fn set_map<K, V, I>(&mut self, headers: I) -> &mut Request where K: Into<String>, V: Into<String>, I: IntoIterator<Item = (K, V)>, { for (k, v) in headers.into_iter() { self.set(k, v); } self } /// Set a query parameter. /// /// For example, to set `?format=json&dest=/login` /// /// ``` /// let r = ureq::get("/my_page") /// .query("format", "json") /// .query("dest", "/login") /// .call(); /// /// println!("{:?}", r); /// ``` pub fn query<K, V>(&mut self, param: K, value: V) -> &mut Request where K: Into<String>, V: Into<String>, { self.query.add_pair((param.into(), value.into())); self } /// Set many query parameters. /// /// For example, to set `?format=json&dest=/login` /// /// ``` /// #[macro_use] /// extern crate ureq; /// /// fn main() { /// let r = ureq::get("/my_page") /// .query_map(map! { /// "format" => "json", /// "dest" => "/login" /// }) /// .call(); /// /// println!("{:?}", r); /// } /// ``` pub fn query_map<K, V, I>(&mut self, params: I) -> &mut Request where K: Into<String>, V: Into<String>, I: IntoIterator<Item = (K, V)>, { for (k, v) in params.into_iter() { self.query.add_pair((k.into(), v.into())); } self } /// Set query parameters as a string. /// /// For example, to set `?format=json&dest=/login` /// /// ``` /// let r = ureq::get("/my_page") /// .query_str("?format=json&dest=/login") /// .call(); /// println!("{:?}", r); /// ``` pub fn query_str<S>(&mut self, query: S) -> &mut Request where S: Into<String>, { let s = query.into(); self.query.add_str(&s); self } /// Timeout for the socket connection to be successful. /// /// The default is `0`, which means a request can block forever. /// /// ``` /// let r = ureq::get("/my_page") /// .timeout_connect(1_000) // wait max 1 second to connect /// .call(); /// println!("{:?}", r); /// ``` pub fn timeout_connect(&mut self, millis: u64) -> &mut Request { self.timeout_connect = millis; self } /// Timeout for the individual reads of the socket. /// /// The default is `0`, which means it can block forever. /// /// ``` /// let r = ureq::get("/my_page") /// .timeout_read(1_000) // wait max 1 second for the read /// .call(); /// println!("{:?}", r); /// ``` pub fn timeout_read(&mut self, millis: u64) -> &mut Request { self.timeout_read = millis; self } /// Timeout for the individual writes to the socket. /// /// The default is `0`, which means it can block forever. /// /// ``` /// let r = ureq::get("/my_page") /// .timeout_write(1_000) // wait max 1 second for sending. /// .call(); /// println!("{:?}", r); /// ``` pub fn timeout_write(&mut self, millis: u64) -> &mut Request { self.timeout_write = millis; self } /// Basic auth. /// /// These are the same /// /// ``` /// let r1 = ureq::get("http://localhost/my_page") /// .auth("martin", "rubbermashgum") /// .call(); /// println!("{:?}", r1); /// /// let r2 = ureq::get("http://martin:rubbermashgum@localhost/my_page").call(); /// println!("{:?}", r2); /// ``` pub fn auth<S, T>(&mut self, user: S, pass: T) -> &mut Request where S: Into<String>, T: Into<String>, { let u = user.into(); let p = pass.into(); let pass = basic_auth(&u, &p); self.auth_kind("Basic", pass) } /// Auth of other kinds such as `Digest`, `Token` etc. /// /// ``` /// let r = ureq::get("http://localhost/my_page") /// .auth_kind("token", "secret") /// .call(); /// println!("{:?}", r); /// ``` pub fn auth_kind<S, T>(&mut self, kind: S, pass: T) -> &mut Request where S: Into<String>, T: Into<String>, { let value = format!("{} {}", kind.into(), pass.into()); self.set("Authorization", value); self } /// How many redirects to follow. /// /// Defaults to `5`. /// /// ``` /// let r = ureq::get("/my_page") /// .redirects(10) /// .call(); /// println!("{:?}", r); /// ``` pub fn redirects(&mut self, n: u32) -> &mut Request { self.redirects = n; self } // pub fn retry(&self, times: u16) -> Request { // unimplemented!() // } // pub fn sortQuery(&self) -> Request { // unimplemented!() // } // pub fn sortQueryBy(&self, by: Box<Fn(&str, &str) -> usize>) -> Request { // unimplemented!() // } // pub fn ca<S>(&self, accept: S) -> Request // where S: Into<String> { // unimplemented!() // } // pub fn cert<S>(&self, accept: S) -> Request // where S: Into<String> { // unimplemented!() // } // pub fn key<S>(&self, accept: S) -> Request // where S: Into<String> { // unimplemented!() // } // pub fn pfx<S>(&self, accept: S) -> Request // TODO what type? u8? // where S: Into<String> { // unimplemented!() // } /// Get the method this request is using. /// /// Example: /// ``` /// let req = ureq::post("/somewhere") /// .build(); /// assert_eq!(req.get_method(), "POST"); /// ``` pub fn get_method(&self) -> &str { &self.method } /// Get the url this request was created with. /// /// This value is not normalized, it is exactly as set. /// /// Example: /// ``` /// let req = ureq::post("https://cool.server/innit") /// .build(); /// assert_eq!(req.get_url(), "https://cool.server/innit"); /// ``` pub fn get_url(&self) -> &str { &self.path } fn to_url(&self) -> Result<Url, Error> { URL_BASE .join(&self.path) .map_err(|e| Error::BadUrl(format!("{}", e))) } }