// Copyright 2018 Yoshua Wuyts. All rights reserved. MIT license. // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license. // Forked from https://github.com/superfly/accept-encoding/blob/1cded757ec7ff3916e5bfe7441db76cdc48170dc/ // Forked to support both http 0.3 and http 1.0 crates. use itertools::Itertools; /// A list enumerating the categories of errors in this crate. /// /// This list is intended to grow over time and it is not recommended to /// exhaustively match against it. /// /// It is used with the [`Error`] struct. /// /// [`Error`]: std.struct.Error.html #[derive(Debug, thiserror::Error)] pub enum EncodingError { /// Invalid header encoding. #[error("Invalid header encoding.")] InvalidEncoding, /// The encoding scheme is unknown. #[error("Unknown encoding scheme.")] UnknownEncoding, } /// Encodings to use. #[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)] pub enum Encoding { /// The Gzip encoding. Gzip, /// The Deflate encoding. Deflate, /// The Brotli encoding. Brotli, /// The Zstd encoding. Zstd, /// No encoding. Identity, } impl Encoding { /// Parses a given string into its corresponding encoding. fn parse(s: &str) -> Result, EncodingError> { match s { "gzip" => Ok(Some(Encoding::Gzip)), "deflate" => Ok(Some(Encoding::Deflate)), "br" => Ok(Some(Encoding::Brotli)), "zstd" => Ok(Some(Encoding::Zstd)), "identity" => Ok(Some(Encoding::Identity)), "*" => Ok(None), _ => Err(EncodingError::UnknownEncoding), } } } /// Select the encoding with the largest qval or the first with qval ~= 1 pub fn preferred( encodings: impl Iterator, f32), EncodingError>>, ) -> Result, EncodingError> { let mut preferred_encoding = None; let mut max_qval = 0.0; for r in encodings { let (encoding, qval) = r?; if (qval - 1.0f32).abs() < 0.01 { return Ok(encoding); } else if qval > max_qval { preferred_encoding = encoding; max_qval = qval; } } Ok(preferred_encoding) } /// Parse a set of HTTP headers into an iterator containing tuples of options containing encodings and their corresponding q-values. /// /// Compatible with `http` crate for version 0.2.x. pub fn encodings_iter_http_02( headers: &http_v02::HeaderMap, ) -> impl Iterator, f32), EncodingError>> + '_ { let iter = headers .get_all(http_v02::header::ACCEPT_ENCODING) .iter() .map(|hval| hval.to_str().map_err(|_| EncodingError::InvalidEncoding)); encodings_iter_inner(iter) } /// Parse a set of HTTP headers into an iterator containing tuples of options containing encodings and their corresponding q-values. /// /// Compatible with `http` crate for version 1.x. pub fn encodings_iter_http_1( headers: &http::HeaderMap, ) -> impl Iterator, f32), EncodingError>> + '_ { let iter = headers .get_all(http::header::ACCEPT_ENCODING) .iter() .map(|hval| hval.to_str().map_err(|_| EncodingError::InvalidEncoding)); encodings_iter_inner(iter) } /// Parse a set of HTTP headers into an iterator containing tuples of options containing encodings and their corresponding q-values. fn encodings_iter_inner<'s>( headers: impl Iterator> + 's, ) -> impl Iterator, f32), EncodingError>> + 's { headers .map_ok(|s| s.split(',').map(str::trim)) .flatten_ok() .filter_map_ok(|v| { let (e, q) = match v.split_once(";q=") { Some((e, q)) => (e, q), None => return Some(Ok((Encoding::parse(v).ok()?, 1.0f32))), }; let encoding = Encoding::parse(e).ok()?; // ignore unknown encodings let qval = match q.parse() { Ok(f) if f > 1.0 => return Some(Err(EncodingError::InvalidEncoding)), // q-values over 1 are unacceptable, Ok(f) => f, Err(_) => return Some(Err(EncodingError::InvalidEncoding)), }; Some(Ok((encoding, qval))) }) .map(|r| r?) // flatten Result Result, f32)>, EncodingError> { encodings_iter_http_02(headers).collect() } fn parse(headers: &HeaderMap) -> Result, EncodingError> { preferred(encodings_iter_http_02(headers)) } #[test] fn single_encoding() { let mut headers = HeaderMap::new(); headers.insert(ACCEPT_ENCODING, HeaderValue::from_str("gzip").unwrap()); let encoding = parse(&headers).unwrap().unwrap(); assert_eq!(encoding, Encoding::Gzip); } #[test] fn multiple_encodings() { let mut headers = HeaderMap::new(); headers.insert( ACCEPT_ENCODING, HeaderValue::from_str("gzip, deflate, br").unwrap(), ); let encoding = parse(&headers).unwrap().unwrap(); assert_eq!(encoding, Encoding::Gzip); } #[test] fn single_encoding_with_qval() { let mut headers = HeaderMap::new(); headers.insert( ACCEPT_ENCODING, HeaderValue::from_str("deflate;q=1.0").unwrap(), ); let encoding = parse(&headers).unwrap().unwrap(); assert_eq!(encoding, Encoding::Deflate); } #[test] fn multiple_encodings_with_qval_1() { let mut headers = HeaderMap::new(); headers.insert( ACCEPT_ENCODING, HeaderValue::from_str("deflate, gzip;q=1.0, *;q=0.5").unwrap(), ); let encoding = parse(&headers).unwrap().unwrap(); assert_eq!(encoding, Encoding::Deflate); } #[test] fn multiple_encodings_with_qval_2() { let mut headers = HeaderMap::new(); headers.insert( ACCEPT_ENCODING, HeaderValue::from_str("gzip;q=0.5, deflate;q=1.0, *;q=0.5").unwrap(), ); let encoding = parse(&headers).unwrap().unwrap(); assert_eq!(encoding, Encoding::Deflate); } #[test] fn multiple_encodings_with_qval_3() { let mut headers = HeaderMap::new(); headers.insert( ACCEPT_ENCODING, HeaderValue::from_str("gzip;q=0.5, deflate;q=0.75, *;q=1.0").unwrap(), ); let encoding = parse(&headers).unwrap(); assert!(encoding.is_none()); } #[test] fn list_encodings() { let mut headers = HeaderMap::new(); headers.insert( ACCEPT_ENCODING, HeaderValue::from_str("zstd;q=1.0, deflate;q=0.8, br;q=0.9").unwrap(), ); let encodings = encodings(&headers).unwrap(); assert_eq!(encodings[0], (Some(Encoding::Zstd), 1.0)); assert_eq!(encodings[1], (Some(Encoding::Deflate), 0.8)); assert_eq!(encodings[2], (Some(Encoding::Brotli), 0.9)); } #[test] fn list_encodings_ignore_unknown() { let mut headers = HeaderMap::new(); headers.insert( ACCEPT_ENCODING, HeaderValue::from_str("zstd;q=1.0, unknown;q=0.8, br;q=0.9").unwrap(), ); let encodings = encodings(&headers).unwrap(); assert_eq!(encodings[0], (Some(Encoding::Zstd), 1.0)); assert_eq!(encodings[1], (Some(Encoding::Brotli), 0.9)); } }