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
use super::FastlyResponseMetadata; use crate::abi::{self, FastlyStatus, MultiValueHostcallError}; use crate::body::{Body, BodyHandle, StreamingBodyHandle}; use crate::error::BufferSizeError; use bytes::{BufMut, BytesMut}; use http::header::{HeaderName, HeaderValue}; use http::{Response, StatusCode, Version}; use std::convert::TryFrom; /// A low-level interface to HTTP responses. /// /// A response handle can be immediately sent downstream to the client using /// [`send_downstream`], or streamed back to the client with [`send_downstream_streaming`], given /// a [`BodyHandle`]. /// /// [`send_downstream`]: struct.ResponseHandle.html#method.send_downstream /// [`send_downstream_streaming`]: struct.ResponseHandle.html#method.send_downstream /// [`BodyHandle`]: ../body/struct.BodyHandle.html #[derive(Debug, Eq, Hash, PartialEq)] #[repr(transparent)] pub struct ResponseHandle { pub(crate) handle: u32, } impl ResponseHandle { /// An invalid handle. pub const INVALID: Self = ResponseHandle { handle: fastly_shared::INVALID_RESPONSE_HANDLE, }; /// Return true if the response handle is valid. pub fn is_valid(&self) -> bool { !self.is_invalid() } /// Return true if the response handle is invalid. pub fn is_invalid(&self) -> bool { self.handle == Self::INVALID.handle } /// Get the underlying representation of the handle. /// /// This should only be used when calling the raw ABI directly, and care should be taken not to /// reuse or alias handle values. pub(crate) fn as_u32(&self) -> u32 { self.handle } /// Get a mutable reference to the underlying `u32` representation of the handle. /// /// This should only be used when calling the raw ABI directly, and care should be taken not to /// reuse or alias handle values. pub(crate) fn as_u32_mut(&mut self) -> &mut u32 { &mut self.handle } /// Acquire a new response handle. #[allow(clippy::new_without_default)] pub fn new() -> Self { let mut handle = ResponseHandle::INVALID; let status = unsafe { abi::fastly_http_resp::new(handle.as_u32_mut()) }; match status.result().map(|_| handle) { Ok(h) if h.is_valid() => h, _ => panic!("fastly_http_resp::new failed"), } } /// Read a response's header names via a buffer of the provided size. /// /// If there is a header name that is longer than the provided buffer, this will return a /// [`BufferSizeError`][buf-err]; you can retry with a larger buffer size if necessary. /// /// [buf-err]: ../error/struct.BufferSizeError.html pub fn get_header_names<'a>( &'a self, max_len: usize, ) -> impl Iterator<Item = Result<HeaderName, BufferSizeError>> + 'a { abi::MultiValueHostcall::new( b'\0', max_len, move |buf, buf_size, cursor, ending_cursor, nwritten| unsafe { abi::fastly_http_resp::header_names_get( self.as_u32(), buf, buf_size, cursor, ending_cursor, nwritten, ) }, ) .map(move |res| { use MultiValueHostcallError::{BufferTooSmall, ClosureError}; match res { // we trust that the hostcall is giving us valid header bytes Ok(name_bytes) => Ok(HeaderName::from_bytes(&name_bytes).unwrap()), // return an error if the buffer was not large enough Err(BufferTooSmall) => Err(BufferSizeError::new(max_len)), // panic if the hostcall failed for some other reason Err(ClosureError(e)) => { panic!("fastly_http_resp::header_names_get returned error: {:?}", e) } } }) } /// Get a response's header values given a header name, via a buffer of the provided size. /// /// If there is a header value that is longer than the provided buffer, this will return a /// [`BufferSizeError`][buf-err]; you can retry with a larger buffer size if necessary. /// /// ### Examples /// /// Collect all the header values into a `Vec`: /// /// ```no_run /// # use fastly::error::Error; /// # use fastly::response::ResponseHandle; /// # use http::header::{HeaderName, HeaderValue}; /// # /// # fn main() -> Result<(), Error> { /// # let response = ResponseHandle::new(); /// let name = HeaderName::from_static("My-App-Header"); /// let buf_size = 128; /// let header_values: Vec<HeaderValue> = response /// .get_header_values(&name, buf_size) /// .collect::<Result<Vec<HeaderValue>, _>>()?; /// # Ok(()) /// # } /// ``` /// /// To try again with a larger buffer if the first call fails, you can use /// [`unwrap_or_else`][unwrap]: /// /// ```no_run /// # use fastly::error::BufferSizeError; /// # use fastly::response::ResponseHandle; /// # use http::header::{HeaderName, HeaderValue}; /// # let response = ResponseHandle::new(); /// let name = HeaderName::from_static("My-App-Header"); /// let buf_size = 128; /// /// // Collect header values into a `Vec<HeaderValue>`, with a buffer size of `128`. /// // If the first call fails, print our error and then try to collect header values /// // again. The second call will use a larger buffer size of `1024`. /// let header_values: Vec<HeaderValue> = response /// .get_header_values(&name, buf_size) /// .collect::<Result<_, _>>() /// .unwrap_or_else(|err: BufferSizeError| { /// eprintln!("buffer size error: {}", err); /// let larger_buf_size = 1024; /// response /// .get_header_values(&name, larger_buf_size) /// .collect::<Result<_, _>>() /// .unwrap() /// }); /// ``` /// /// [buf-err]: ../error/struct.BufferSizeError.html /// [unwrap]: https://doc.rust-lang.org/std/result/enum.Result.html#method.unwrap_or_else pub fn get_header_values<'a>( &'a self, name: &'a HeaderName, max_len: usize, ) -> impl Iterator<Item = Result<HeaderValue, BufferSizeError>> + 'a { abi::MultiValueHostcall::new( b'\0', max_len, move |buf, buf_size, cursor, ending_cursor, nwritten| unsafe { let name: &[u8] = name.as_ref(); abi::fastly_http_resp::header_values_get( self.as_u32(), name.as_ptr(), name.len(), buf, buf_size, cursor, ending_cursor, nwritten, ) }, ) .map(move |res| { use MultiValueHostcallError::{BufferTooSmall, ClosureError}; match res { Ok(value_bytes) => { let header_value = unsafe { HeaderValue::from_maybe_shared_unchecked(value_bytes) }; Ok(header_value) } Err(BufferTooSmall) => Err(BufferSizeError::new(max_len)), Err(ClosureError(e)) => panic!( "fastly_http_resp::header_values_get returned error: {:?}", e ), } }) } /// Set a response's header values given a header name and a collection of header values. pub fn set_header_values<'a, I>(&mut self, name: &HeaderName, values: I) where I: IntoIterator<Item = &'a HeaderValue>, { // build a buffer of all the values, each terminated by a nul byte let mut buf = vec![]; for value in values { buf.put(value.as_bytes()); buf.put_u8(b'\0'); } let name: &[u8] = name.as_ref(); unsafe { abi::fastly_http_resp::header_values_set( self.as_u32(), name.as_ptr(), name.len(), buf.as_ptr(), buf.len(), ) } .result() .expect("fastly_http_resp::header_values_set failed"); } /// Get a response's [`HeaderValue`][value], given the [`HeaderName`][name]. /// /// If there are multiple values associated with the name, then the first one is returned. /// /// If the value is longer than the provided buffer, this will return a /// [`BufferSizeError`][buf-err]; you can retry with a larger buffer size if necessary. /// /// If no header exists with the given name, this function will return `Ok(None)`. /// /// [buf-err]: ../error/struct.BufferSizeError.html /// [name]: https://docs.rs/http/latest/http/header/struct.HeaderName.html /// [value]: https://docs.rs/http/latest/http/header/struct.HeaderValue.html pub fn get_header_value( &self, name: &HeaderName, max_len: usize, ) -> Result<Option<HeaderValue>, BufferSizeError> { let name: &[u8] = name.as_ref(); let mut buf = BytesMut::with_capacity(max_len); let mut nwritten = 0; let status = unsafe { abi::fastly_http_resp::header_value_get( self.as_u32(), name.as_ptr(), name.len(), buf.as_mut_ptr(), buf.capacity(), &mut nwritten, ) }; match status.result().map(|_| nwritten) { Ok(nwritten) => { assert!(nwritten <= buf.capacity(), "hostcall wrote too many bytes"); unsafe { buf.set_len(nwritten); } // we trust that the hostcall is giving us valid header bytes let value = HeaderValue::from_bytes(&buf).expect("bytes from host are valid"); Ok(Some(value)) } Err(FastlyStatus::INVAL) => Ok(None), Err(FastlyStatus::BUFLEN) => Err(BufferSizeError::new(max_len)), _ => panic!("fastly_http_resp::header_value_get returned error"), } } /// Insert a new key-value pair into the response's headers. /// /// If this [`HeaderName`][name] key already existed in the response's headers, associated /// [`HeaderValue`][value]s will be overwritten. To preserve pre-existing values, use /// [`append_header`][append] instead. /// /// [append]: struct.ResponseHandle.html#method.append_header /// [name]: https://docs.rs/http/latest/http/header/struct.HeaderName.html /// [value]: https://docs.rs/http/latest/http/header/struct.HeaderValue.html pub fn insert_header(&mut self, name: &HeaderName, value: &HeaderValue) { let name_bytes: &[u8] = name.as_ref(); let value_bytes: &[u8] = value.as_ref(); unsafe { abi::fastly_http_resp::header_insert( self.as_u32(), name_bytes.as_ptr(), name_bytes.len(), value_bytes.as_ptr(), value_bytes.len(), ) } .result() .expect("fastly_http_resp::header_insert returned error"); } /// Append a new key-value pair to the response's headers. /// /// If this [`HeaderName`][name] key already existed in the response's headers, the new /// [`HeaderValue`][value]s will be added the end of the values associated with that key. To /// overwrite other pre-existing values, use [`insert_header`][insert] instead. /// /// [insert]: struct.ResponseHandle.html#method.insert_header /// [name]: https://docs.rs/http/latest/http/header/struct.HeaderName.html /// [value]: https://docs.rs/http/latest/http/header/struct.HeaderValue.html pub fn append_header(&mut self, name: &HeaderName, value: &HeaderValue) { let name_bytes: &[u8] = name.as_ref(); let value_bytes: &[u8] = value.as_ref(); unsafe { abi::fastly_http_resp::header_append( self.as_u32(), name_bytes.as_ptr(), name_bytes.len(), value_bytes.as_ptr(), value_bytes.len(), ) } .result() .expect("fastly_http_resp::header_append returned error"); } /// Remove a header from the response, returning `true` if it was formerly present or `false` /// otherwise. pub fn remove_header(&mut self, name: &HeaderName) -> bool { let name_bytes: &[u8] = name.as_ref(); let status = unsafe { abi::fastly_http_resp::header_remove( self.as_u32(), name_bytes.as_ptr(), name_bytes.len(), ) }; match status.result() { Ok(_) => true, Err(FastlyStatus::INVAL) => false, _ => panic!("fastly_http_resp::header_remove returned error"), } } /// Set the response's /// [`StatusCode`](https://docs.rs/http/latest/http/status/struct.StatusCode.html). pub fn set_status(&mut self, status: StatusCode) { unsafe { abi::fastly_http_resp::status_set(self.as_u32(), status.as_u16()) } .result() .expect("fastly_http_resp::status_set returned error") } /// Get the response's /// [`StatusCode`](https://docs.rs/http/latest/http/status/struct.StatusCode.html). pub fn get_status(&self) -> StatusCode { let mut status = 0; let fastly_status = unsafe { abi::fastly_http_resp::status_get(self.as_u32(), &mut status) }; match fastly_status.result().map(|_| status) { Ok(status) => StatusCode::from_u16(status).expect("invalid http status"), _ => panic!("fastly_http_resp::status_get failed"), } } /// Get the response's /// [`Version`](https://docs.rs/http/latest/http/version/struct.Version.html). pub fn get_version(&self) -> Version { let mut version = 0; let status = unsafe { abi::fastly_http_resp::version_get(self.as_u32(), &mut version) }; if status.is_err() { panic!("fastly_http_resp::version_get failed"); } else { abi::HttpVersion::try_from(version) .map(Into::into) .expect("invalid http version") } } /// Set the response's /// [`Version`](https://docs.rs/http/latest/http/version/struct.Version.html). pub fn set_version(&mut self, v: Version) { unsafe { abi::fastly_http_resp::version_set(self.as_u32(), abi::HttpVersion::from(v) as u32) } .result() .expect("fastly_http_resp::version_get failed"); } /// Immediately begin sending this response downstream to the client with the given body. pub fn send_downstream(self, body: BodyHandle) { unsafe { abi::fastly_http_resp::send_downstream(self.as_u32(), body.as_u32(), false as u32) } .result() .expect("fastly_http_resp::send_downstream failed"); } /// Immediately begin sending this response downstream to the client, and return a /// `StreamingBodyHandle` that can accept further data to send. pub fn send_downstream_streaming(self, body: BodyHandle) -> StreamingBodyHandle { let streaming_body_handle = StreamingBodyHandle::from_body_handle(&body); let status = unsafe { abi::fastly_http_resp::send_downstream(self.as_u32(), body.as_u32(), true as u32) }; status .result() .map(|_| streaming_body_handle) .expect("fastly_http_resp::send_downstream failed") } } pub(crate) fn handles_to_response( resp_handle: ResponseHandle, resp_body_handle: BodyHandle, metadata: FastlyResponseMetadata, ) -> Response<Body> { let mut resp = Response::builder() .status(resp_handle.get_status()) .version(resp_handle.get_version()) .extension(metadata); for name in resp_handle.get_header_names(crate::HEADER_NAME_MAX_LEN) { let name = name.expect("response header names too large"); for value in resp_handle.get_header_values(&name, crate::HEADER_VALUE_MAX_LEN) { let value = value.expect("response header values too large"); resp = resp.header(&name, value); } } resp.body(resp_body_handle.into()) .expect("invalid response") }