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
// Copyright (c) 2016 The Rouille developers // Licensed under the Apache License, Version 2.0 // <LICENSE-APACHE or // http://www.apache.org/licenses/LICENSE-2.0> or the MIT // license <LICENSE-MIT or http://opensource.org/licenses/MIT>, // at your option. All files in the project carrying such // notice may not be copied, modified, or distributed except // according to those terms. use std::io; use std::io::Cursor; use std::io::Read; use std::fs::File; use rustc_serialize; /// Contains a prototype of a response. /// /// The response is only sent to the client when you return the `Response` object from your /// request handler. This means that you are free to create as many `Response` objects as you want. pub struct Response { /// The status code to return to the user. pub status_code: u16, /// List of headers to be returned in the response. /// /// Note that important headers such as `Connection` or `Content-Length` will be ignored /// from this list. // TODO: document precisely which headers pub headers: Vec<(String, String)>, /// An opaque type that contains the body of the response. pub data: ResponseBody, } impl Response { /// Returns true if the status code of this `Response` indicates success. /// /// This is the range [200-399]. /// /// # Example /// /// ``` /// use rouille::Response; /// let response = Response::text("hello world"); /// assert!(response.success()); /// ``` #[inline] pub fn success(&self) -> bool { self.status_code >= 200 && self.status_code < 400 } /// Shortcut for `!response.success()`. /// /// # Example /// /// ``` /// use rouille::Response; /// let response = Response::empty_400(); /// assert!(response.error()); /// ``` #[inline] pub fn error(&self) -> bool { !self.success() } /// Builds a `Response` that redirects the user to another URL with a 303 status code. /// /// # Example /// /// ``` /// use rouille::Response; /// let response = Response::redirect("/foo"); /// ``` #[inline] pub fn redirect(target: &str) -> Response { Response { status_code: 303, headers: vec![("Location".to_owned(), target.to_owned())], data: ResponseBody::empty(), } } /// Builds a `Response` that outputs HTML. /// /// # Example /// /// ``` /// use rouille::Response; /// let response = Response::text("<p>hello <strong>world</strong></p>"); /// ``` #[inline] pub fn html<D>(content: D) -> Response where D: Into<Vec<u8>> { Response { status_code: 200, headers: vec![("Content-Type".to_owned(), "text/html; charset=utf8".to_owned())], data: ResponseBody::from_data(content), } } /// Builds a `Response` that outputs SVG. /// /// # Example /// /// ``` /// use rouille::Response; /// let response = Response::svg("<svg xmlns='http://www.w3.org/2000/svg'/>"); /// ``` #[inline] pub fn svg<D>(content: D) -> Response where D: Into<Vec<u8>> { Response { status_code: 200, headers: vec![("Content-Type".to_owned(), "image/svg+xml; charset=utf8".to_owned())], data: ResponseBody::from_data(content), } } /// Builds a `Response` that outputs plain text. /// /// # Example /// /// ``` /// use rouille::Response; /// let response = Response::text("hello world"); /// ``` #[inline] pub fn text<S>(text: S) -> Response where S: Into<String> { Response { status_code: 200, headers: vec![("Content-Type".to_owned(), "text/plain; charset=utf8".to_owned())], data: ResponseBody::from_string(text), } } /// Builds a `Response` that outputs JSON. /// /// # Example /// /// ``` /// extern crate rustc_serialize; /// # #[macro_use] extern crate rouille; /// use rouille::Response; /// # fn main() { /// /// #[derive(RustcEncodable)] /// struct MyStruct { /// field1: String, /// field2: i32, /// } /// /// let response = Response::json(&MyStruct { field1: "hello".to_owned(), field2: 5 }); /// // The Response will contain something like `{ field1: "hello", field2: 5 }` /// # } /// ``` #[inline] pub fn json<T>(content: &T) -> Response where T: rustc_serialize::Encodable { let data = rustc_serialize::json::encode(content).unwrap(); Response { status_code: 200, headers: vec![("Content-Type".to_owned(), "application/json".to_owned())], data: ResponseBody::from_data(data), } } /// Builds a `Response` that returns a `401 Not Authorized` status /// and a `WWW-Authenticate` header. /// /// # Example /// /// ``` /// use rouille::Response; /// let response = Response::basic_http_auth_login_required("realm"); /// ``` #[inline] pub fn basic_http_auth_login_required(realm: &str) -> Response { // TODO: escape the realm Response { status_code: 401, headers: vec![("WWW-Authenticate".to_owned(), format!("Basic realm=\"{}\"", realm))], data: ResponseBody::empty(), } } /// Builds an empty `Response` with a 400 status code. /// /// # Example /// /// ``` /// use rouille::Response; /// let response = Response::empty_400(); /// ``` #[inline] pub fn empty_400() -> Response { Response { status_code: 400, headers: vec![], data: ResponseBody::empty() } } /// Builds an empty `Response` with a 404 status code. /// /// # Example /// /// ``` /// use rouille::Response; /// let response = Response::empty_404(); /// ``` #[inline] pub fn empty_404() -> Response { Response { status_code: 404, headers: vec![], data: ResponseBody::empty() } } /// Changes the status code of the response. /// /// # Example /// /// ``` /// use rouille::Response; /// let response = Response::text("hello world").with_status_code(500); /// ``` #[inline] pub fn with_status_code(mut self, code: u16) -> Response { self.status_code = code; self } } /// An opaque type that represents the body of a response. /// /// You can't access the inside of this struct, but you can build one by using one of the provided /// constructors. /// /// # Example /// /// ``` /// use rouille::ResponseBody; /// let body = ResponseBody::from_string("hello world"); /// ``` pub struct ResponseBody { data: Box<Read + Send>, data_length: Option<usize>, } impl ResponseBody { /// UNSTABLE. Extracts the content of the response. Do not use. #[doc(hidden)] #[inline] pub fn into_inner(self) -> (Box<Read + Send>, Option<usize>) { (self.data, self.data_length) } /// Builds a `ResponseBody` that doesn't return any data. /// /// # Example /// /// ``` /// use rouille::ResponseBody; /// let body = ResponseBody::empty(); /// ``` #[inline] pub fn empty() -> ResponseBody { ResponseBody { data: Box::new(io::empty()), data_length: Some(0), } } /// Builds a new `ResponseBody` that will read the data from a `Read`. /// /// Note that this is suboptimal compared to other constructors because the length /// isn't known in advance. /// /// # Example /// /// ```no_run /// use std::io; /// use std::io::Read; /// use rouille::ResponseBody; /// /// let body = ResponseBody::from_reader(io::stdin().take(128)); /// ``` #[inline] pub fn from_reader<R>(data: R) -> ResponseBody where R: Read + Send + 'static { ResponseBody { data: Box::new(data), data_length: None, } } /// Builds a new `ResponseBody` that returns the given data. /// /// # Example /// /// ``` /// use rouille::ResponseBody; /// let body = ResponseBody::from_data(vec![12u8, 97, 34]); /// ``` #[inline] pub fn from_data<D>(data: D) -> ResponseBody where D: Into<Vec<u8>> { let data = data.into(); let len = data.len(); ResponseBody { data: Box::new(Cursor::new(data)), data_length: Some(len), } } /// Builds a new `ResponseBody` that returns the content of the given file. /// /// # Example /// /// ```no_run /// use std::fs::File; /// use rouille::ResponseBody; /// /// let file = File::open("page.html").unwrap(); /// let body = ResponseBody::from_file(file); /// ``` #[inline] pub fn from_file(file: File) -> ResponseBody { let len = file.metadata().map(|metadata| metadata.len() as usize).ok(); ResponseBody { data: Box::new(file), data_length: len, } } /// Builds a new `ResponseBody` that returns an UTF-8 string. /// /// # Example /// /// ``` /// use rouille::ResponseBody; /// let body = ResponseBody::from_string("hello world"); /// ``` #[inline] pub fn from_string<S>(data: S) -> ResponseBody where S: Into<String> { ResponseBody::from_data(data.into().into_bytes()) } }