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
use crate::connection::Connection; use crate::{Error, Response, ResponseLazy}; use std::collections::HashMap; use std::fmt; /// A URL type for requests. pub type URL = String; /// An HTTP request method. #[derive(Clone, PartialEq, Debug)] pub enum Method { /// The GET method Get, /// The HEAD method Head, /// The POST method Post, /// The PUT method Put, /// The DELETE method Delete, /// The CONNECT method Connect, /// The OPTIONS method Options, /// The TRACE method Trace, /// The PATCH method Patch, /// A custom method, use with care: the string will be embedded in /// your request as-is. Custom(String), } impl fmt::Display for Method { /// Formats the Method to the form in the HTTP request, /// ie. Method::Get -> "GET", Method::Post -> "POST", etc. fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match *self { Method::Get => write!(f, "GET"), Method::Head => write!(f, "HEAD"), Method::Post => write!(f, "POST"), Method::Put => write!(f, "PUT"), Method::Delete => write!(f, "DELETE"), Method::Connect => write!(f, "CONNECT"), Method::Options => write!(f, "OPTIONS"), Method::Trace => write!(f, "TRACE"), Method::Patch => write!(f, "PATCH"), Method::Custom(ref s) => write!(f, "{}", s), } } } /// An HTTP request. #[derive(Clone, PartialEq, Debug)] pub struct Request { pub(crate) method: Method, pub(crate) host: URL, resource: URL, headers: HashMap<String, String>, body: Option<Vec<u8>>, pub(crate) timeout: Option<u64>, max_redirects: usize, https: bool, pub(crate) redirects: Vec<(bool, URL, URL)>, } impl Request { /// Creates a new HTTP `Request`. /// /// This is only the request's data, it is not sent yet. For /// sending the request, see [`send`](struct.Request.html#method.send). pub fn new<T: Into<URL>>(method: Method, url: T) -> Request { let (https, host, resource) = parse_url(url.into()); Request { method, host, resource, headers: HashMap::new(), body: None, timeout: None, max_redirects: 100, https, redirects: Vec::new(), } } /// Adds a header to the request this is called on. Use this /// function to add headers to your requests. pub fn with_header<T: Into<String>, U: Into<String>>(mut self, key: T, value: U) -> Request { self.headers.insert(key.into(), value.into()); self } /// Sets the request body. pub fn with_body<T: Into<Vec<u8>>>(mut self, body: T) -> Request { let body = body.into(); let body_length = body.len(); self.body = Some(body); self.with_header("Content-Length", format!("{}", body_length)) } /// Converts given argument to JSON and sets it as body. /// /// # Errors /// /// Returns /// [`SerdeJsonError`](enum.Error.html#variant.SerdeJsonError) if /// Serde runs into a problem when converting `body` into a /// string. #[cfg(feature = "json-using-serde")] pub fn with_json<T: serde::ser::Serialize>(mut self, body: &T) -> Result<Request, Error> { self.headers.insert( "Content-Type".to_string(), "application/json; charset=UTF-8".to_string(), ); match serde_json::to_string(&body) { Ok(json) => Ok(self.with_body(json)), Err(err) => Err(Error::SerdeJsonError(err)), } } /// Sets the request timeout. pub fn with_timeout(mut self, timeout: u64) -> Request { self.timeout = Some(timeout); self } /// Sets the max redirects we follow until giving up. 100 by /// default. /// /// Warning: setting this to a very high number, such as 1000, may /// cause a stack overflow if that many redirects are followed. If /// you have a use for so many redirects that the stack overflow /// becomes a problem, please open an issue. pub fn with_max_redirects(mut self, max_redirects: usize) -> Request { self.max_redirects = max_redirects; self } /// Sends this request to the host. /// /// # Errors /// /// Returns `Err` if we run into an error while sending the /// request, or receiving/parsing the response. The specific error /// is described in the `Err`, and it can be any /// [`minreq::Error`](enum.Error.html) except /// [`SerdeJsonError`](enum.Error.html#variant.SerdeJsonError) and /// [`InvalidUtf8InBody`](enum.Error.html#variant.InvalidUtf8InBody). #[cfg(feature = "https")] pub fn send(self) -> Result<Response, Error> { if self.https { let is_head = self.method == Method::Head; let response = Connection::new(self).send_https()?; Response::create(response, is_head) } else { let is_head = self.method == Method::Head; let response = Connection::new(self).send()?; Response::create(response, is_head) } } /// Sends this request to the host, loaded lazily. /// /// # Errors /// /// Returns `Err` if we run into an error while sending the /// request, or receiving/parsing the response. The specific error /// is described in the `Err`, and it can be any /// [`minreq::Error`](enum.Error.html) except /// [`SerdeJsonError`](enum.Error.html#variant.SerdeJsonError) and /// [`InvalidUtf8InBody`](enum.Error.html#variant.InvalidUtf8InBody). #[cfg(feature = "https")] pub fn send_lazy(self) -> Result<ResponseLazy, Error> { if self.https { Connection::new(self).send_https() } else { Connection::new(self).send() } } /// Sends this request to the host. /// /// # Errors /// /// Returns `Err` if we run into an error while sending the /// request, or receiving/parsing the response. The specific error /// is described in the `Err`, and it can be any /// [`minreq::Error`](enum.Error.html) except /// [`SerdeJsonError`](enum.Error.html#variant.SerdeJsonError) and /// [`InvalidUtf8InBody`](enum.Error.html#variant.InvalidUtf8InBody). #[cfg(not(feature = "https"))] pub fn send(self) -> Result<Response, Error> { if self.https { Err(Error::HttpsFeatureNotEnabled) } else { let is_head = self.method == Method::Head; let response = Connection::new(self).send()?; Response::create(response, is_head) } } /// Sends this request to the host, loaded lazily. /// /// # Errors /// /// Returns `Err` if we run into an error while sending the /// request, or receiving/parsing the response. The specific error /// is described in the `Err`, and it can be any /// [`minreq::Error`](enum.Error.html) except /// [`SerdeJsonError`](enum.Error.html#variant.SerdeJsonError) and /// [`InvalidUtf8InBody`](enum.Error.html#variant.InvalidUtf8InBody). #[cfg(not(feature = "https"))] pub fn send_lazy(self) -> Result<ResponseLazy, Error> { if self.https { Err(Error::HttpsFeatureNotEnabled) } else { Connection::new(self).send() } } fn get_http_head(&self) -> String { let mut http = String::with_capacity(32); // Add the request line and the "Host" header http += &format!( "{} {} HTTP/1.1\r\nHost: {}\r\n", self.method, self.resource, self.host ); // Add other headers for (k, v) in &self.headers { http += &format!("{}: {}\r\n", k, v); } http += "\r\n"; http } /// Returns the HTTP request as bytes, ready to be sent to /// the server. pub(crate) fn as_bytes(&self) -> Vec<u8> { let mut head = self.get_http_head().into_bytes(); if let Some(body) = &self.body { head.extend(body); } head } /// Returns the redirected version of this Request, unless an infinite redirection loop was detected. pub(crate) fn redirect_to(mut self, url: URL) -> Result<Request, Error> { self.redirects.push((self.https, self.host, self.resource)); let (https, host, resource) = parse_url(url); self.host = host; self.resource = resource; self.https = https; let is_this_url = |(https_, host_, resource_): &(bool, URL, URL)| { *resource_ == self.resource && *host_ == self.host && *https_ == https }; if self.redirects.len() > self.max_redirects { Err(Error::TooManyRedirections) } else if self.redirects.iter().any(is_this_url) { Err(Error::InfiniteRedirectionLoop) } else { Ok(self) } } } fn parse_url(url: URL) -> (bool, URL, URL) { let mut first = URL::new(); let mut second = URL::new(); let mut slashes = 0; for c in url.chars() { if c == '/' { slashes += 1; } else if slashes == 2 { first.push(c); } if slashes >= 3 { second.push(c); } } // Ensure the resource is *something* if second.is_empty() { second += "/"; } // Set appropriate port let https = url.starts_with("https://"); if !first.contains(':') { first += if https { ":443" } else { ":80" }; } (https, first, second) } /// Alias for [Request::new](struct.Request.html#method.new) with `method` set to /// [Method::Get](enum.Method.html). pub fn get<T: Into<URL>>(url: T) -> Request { Request::new(Method::Get, url) } /// Alias for [Request::new](struct.Request.html#method.new) with `method` set to /// [Method::Head](enum.Method.html). pub fn head<T: Into<URL>>(url: T) -> Request { Request::new(Method::Head, url) } /// Alias for [Request::new](struct.Request.html#method.new) with `method` set to /// [Method::Post](enum.Method.html). pub fn post<T: Into<URL>>(url: T) -> Request { Request::new(Method::Post, url) } /// Alias for [Request::new](struct.Request.html#method.new) with `method` set to /// [Method::Put](enum.Method.html). pub fn put<T: Into<URL>>(url: T) -> Request { Request::new(Method::Put, url) } /// Alias for [Request::new](struct.Request.html#method.new) with `method` set to /// [Method::Delete](enum.Method.html). pub fn delete<T: Into<URL>>(url: T) -> Request { Request::new(Method::Delete, url) } /// Alias for [Request::new](struct.Request.html#method.new) with `method` set to /// [Method::Connect](enum.Method.html). pub fn connect<T: Into<URL>>(url: T) -> Request { Request::new(Method::Connect, url) } /// Alias for [Request::new](struct.Request.html#method.new) with `method` set to /// [Method::Options](enum.Method.html). pub fn options<T: Into<URL>>(url: T) -> Request { Request::new(Method::Options, url) } /// Alias for [Request::new](struct.Request.html#method.new) with `method` set to /// [Method::Trace](enum.Method.html). pub fn trace<T: Into<URL>>(url: T) -> Request { Request::new(Method::Trace, url) } /// Alias for [Request::new](struct.Request.html#method.new) with `method` set to /// [Method::Patch](enum.Method.html). pub fn patch<T: Into<URL>>(url: T) -> Request { Request::new(Method::Patch, url) }