1
0
mirror of https://github.com/fafhrd91/actix-web synced 2024-11-24 00:21:08 +01:00

wrap LanguageTags type in new AnyOrSome type to support wildcards

fixes #2434
This commit is contained in:
Rob Ede 2021-12-01 18:56:33 +00:00
parent 697238fadc
commit 75b026b740
No known key found for this signature in database
GPG Key ID: 97C636207D3EF933
7 changed files with 368 additions and 117 deletions

View File

@ -1,6 +1,17 @@
# Changes # Changes
## Unreleased - 2021-xx-xx ## Unreleased - 2021-xx-xx
### Added
* Methods on `AcceptLanguage`: `ranked` and `preference`. [#????]
### Changed
* Rename `Accept::{mime_precedence => ranked}`. [#????]
* Rename `Accept::{mime_preference => preference}`. [#????]
### Fixed
* Accept wildcard `*` items in `AcceptLanguage`. [#????]
[#????]: https://github.com/actix/actix-web/pull/????
## 4.0.0-beta.13 - 2021-11-30 ## 4.0.0-beta.13 - 2021-11-30

View File

@ -1,8 +1,7 @@
use std::{ use std::{
cmp, cmp,
convert::{TryFrom, TryInto}, convert::{TryFrom, TryInto},
fmt, fmt, str,
str::{self, FromStr},
}; };
use derive_more::{Display, Error}; use derive_more::{Display, Error};
@ -80,19 +79,20 @@ impl TryFrom<f32> for Quality {
} }
/// Represents an item with a quality value as defined in /// Represents an item with a quality value as defined in
/// [RFC7231](https://tools.ietf.org/html/rfc7231#section-5.3.1). /// [RFC 7231](https://tools.ietf.org/html/rfc7231#section-5.3.1).
#[derive(Clone, PartialEq, Debug)] #[derive(Clone, PartialEq, Debug)]
pub struct QualityItem<T> { pub struct QualityItem<T> {
/// The actual contents of the field. /// The wrapped contents of the field.
pub item: T, pub item: T,
/// The quality (client or server preference) for the value. /// The quality (client or server preference) for the value.
pub quality: Quality, pub quality: Quality,
} }
impl<T> QualityItem<T> { impl<T> QualityItem<T> {
/// Creates a new `QualityItem` from an item and a quality. /// Constructs a new `QualityItem` from an item and a quality value.
/// The item can be of any type. ///
/// The quality should be a value in the range [0, 1]. /// The item can be of any type. The quality should be a value in the range [0, 1].
pub fn new(item: T, quality: Quality) -> QualityItem<T> { pub fn new(item: T, quality: Quality) -> QualityItem<T> {
QualityItem { item, quality } QualityItem { item, quality }
} }
@ -116,7 +116,7 @@ impl<T: fmt::Display> fmt::Display for QualityItem<T> {
} }
} }
impl<T: FromStr> FromStr for QualityItem<T> { impl<T: str::FromStr> str::FromStr for QualityItem<T> {
type Err = ParseError; type Err = ParseError;
fn from_str(qitem_str: &str) -> Result<Self, Self::Err> { fn from_str(qitem_str: &str) -> Result<Self, Self::Err> {
@ -128,6 +128,7 @@ impl<T: FromStr> FromStr for QualityItem<T> {
let mut raw_item = qitem_str; let mut raw_item = qitem_str;
let mut quality = 1f32; let mut quality = 1f32;
// TODO: MSRV(1.52): use rsplit_once
let parts: Vec<_> = qitem_str.rsplitn(2, ';').map(str::trim).collect(); let parts: Vec<_> = qitem_str.rsplitn(2, ';').map(str::trim).collect();
if parts.len() == 2 { if parts.len() == 2 {

View File

@ -6,7 +6,7 @@ use super::{qitem, QualityItem};
use crate::http::header; use crate::http::header;
crate::http::header::common_header! { crate::http::header::common_header! {
/// `Accept` header, defined in [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.2) /// `Accept` header, defined in [RFC 7231](http://tools.ietf.org/html/rfc7231#section-5.3.2)
/// ///
/// The `Accept` header field can be used by user agents to specify /// The `Accept` header field can be used by user agents to specify
/// response media types that are acceptable. Accept header fields can /// response media types that are acceptable. Accept header fields can
@ -79,7 +79,7 @@ crate::http::header::common_header! {
/// ``` /// ```
(Accept, header::ACCEPT) => (QualityItem<Mime>)+ (Accept, header::ACCEPT) => (QualityItem<Mime>)+
test_accept { common_tests {
// Tests from the RFC // Tests from the RFC
crate::http::header::common_header_test!( crate::http::header::common_header_test!(
test1, test1,
@ -88,6 +88,7 @@ crate::http::header::common_header! {
QualityItem::new("audio/*".parse().unwrap(), q(200)), QualityItem::new("audio/*".parse().unwrap(), q(200)),
qitem("audio/basic".parse().unwrap()), qitem("audio/basic".parse().unwrap()),
]))); ])));
crate::http::header::common_header_test!( crate::http::header::common_header_test!(
test2, test2,
vec![b"text/plain; q=0.5, text/html, text/x-dvi; q=0.8, text/x-c"], vec![b"text/plain; q=0.5, text/html, text/x-dvi; q=0.8, text/x-c"],
@ -99,6 +100,7 @@ crate::http::header::common_header! {
q(800)), q(800)),
qitem("text/x-c".parse().unwrap()), qitem("text/x-c".parse().unwrap()),
]))); ])));
// Custom tests // Custom tests
crate::http::header::common_header_test!( crate::http::header::common_header_test!(
test3, test3,
@ -154,7 +156,11 @@ impl Accept {
/// [q-factor weighting] and specificity. /// [q-factor weighting] and specificity.
/// ///
/// [q-factor weighting]: https://tools.ietf.org/html/rfc7231#section-5.3.2 /// [q-factor weighting]: https://tools.ietf.org/html/rfc7231#section-5.3.2
pub fn mime_precedence(&self) -> Vec<Mime> { pub fn ranked(&self) -> Vec<Mime> {
if self.is_empty() {
return vec![];
}
let mut types = self.0.clone(); let mut types = self.0.clone();
// use stable sort so items with equal q-factor and specificity retain listed order // use stable sort so items with equal q-factor and specificity retain listed order
@ -204,9 +210,9 @@ impl Accept {
/// Returns `None` if contained list is empty. /// Returns `None` if contained list is empty.
/// ///
/// [q-factor weighting]: https://tools.ietf.org/html/rfc7231#section-5.3.2 /// [q-factor weighting]: https://tools.ietf.org/html/rfc7231#section-5.3.2
pub fn mime_preference(&self) -> Option<Mime> { pub fn preference(&self) -> Option<Mime> {
let types = self.mime_precedence(); // PERF: creating a sorted list is not necessary
types.first().cloned() self.ranked().into_iter().next()
} }
} }
@ -216,12 +222,12 @@ mod tests {
use crate::http::header::q; use crate::http::header::q;
#[test] #[test]
fn test_mime_precedence() { fn ranking_precedence() {
let test = Accept(vec![]); let test = Accept(vec![]);
assert!(test.mime_precedence().is_empty()); assert!(test.ranked().is_empty());
let test = Accept(vec![qitem(mime::APPLICATION_JSON)]); let test = Accept(vec![qitem(mime::APPLICATION_JSON)]);
assert_eq!(test.mime_precedence(), vec!(mime::APPLICATION_JSON)); assert_eq!(test.ranked(), vec!(mime::APPLICATION_JSON));
let test = Accept(vec![ let test = Accept(vec![
qitem(mime::TEXT_HTML), qitem(mime::TEXT_HTML),
@ -230,7 +236,7 @@ mod tests {
QualityItem::new(mime::STAR_STAR, q(0.8)), QualityItem::new(mime::STAR_STAR, q(0.8)),
]); ]);
assert_eq!( assert_eq!(
test.mime_precedence(), test.ranked(),
vec![ vec![
mime::TEXT_HTML, mime::TEXT_HTML,
"application/xhtml+xml".parse().unwrap(), "application/xhtml+xml".parse().unwrap(),
@ -245,20 +251,20 @@ mod tests {
qitem(mime::IMAGE_PNG), qitem(mime::IMAGE_PNG),
]); ]);
assert_eq!( assert_eq!(
test.mime_precedence(), test.ranked(),
vec![mime::IMAGE_PNG, mime::IMAGE_STAR, mime::STAR_STAR] vec![mime::IMAGE_PNG, mime::IMAGE_STAR, mime::STAR_STAR]
); );
} }
#[test] #[test]
fn test_mime_preference() { fn preference_selection() {
let test = Accept(vec![ let test = Accept(vec![
qitem(mime::TEXT_HTML), qitem(mime::TEXT_HTML),
"application/xhtml+xml".parse().unwrap(), "application/xhtml+xml".parse().unwrap(),
QualityItem::new("application/xml".parse().unwrap(), q(0.9)), QualityItem::new("application/xml".parse().unwrap(), q(0.9)),
QualityItem::new(mime::STAR_STAR, q(0.8)), QualityItem::new(mime::STAR_STAR, q(0.8)),
]); ]);
assert_eq!(test.mime_preference(), Some(mime::TEXT_HTML)); assert_eq!(test.preference(), Some(mime::TEXT_HTML));
let test = Accept(vec![ let test = Accept(vec![
QualityItem::new("video/*".parse().unwrap(), q(0.8)), QualityItem::new("video/*".parse().unwrap(), q(0.8)),
@ -267,6 +273,6 @@ mod tests {
qitem(mime::IMAGE_SVG), qitem(mime::IMAGE_SVG),
QualityItem::new(mime::IMAGE_STAR, q(0.8)), QualityItem::new(mime::IMAGE_STAR, q(0.8)),
]); ]);
assert_eq!(test.mime_preference(), Some(mime::IMAGE_PNG)); assert_eq!(test.preference(), Some(mime::IMAGE_PNG));
} }
} }

View File

@ -1,37 +1,40 @@
use language_tags::LanguageTag; use language_tags::LanguageTag;
use super::{QualityItem, ACCEPT_LANGUAGE}; use super::{common_header, AnyOrSome, QualityItem};
use crate::http::header;
crate::http::header::common_header! { common_header! {
/// `Accept-Language` header, defined in /// The `Accept-Language` header field can be used by user agents to indicate the set of natural
/// [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.5) /// languages that are preferred in the response.
/// ///
/// The `Accept-Language` header field can be used by user agents to /// The `Accept-Language` header is defined in
/// indicate the set of natural languages that are preferred in the /// [RFC 7231 §5.3.5](https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.5) using language
/// response. /// ranges defined in [RFC 4647 §2.1](https://datatracker.ietf.org/doc/html/rfc4647#section-2.1).
/// ///
/// # ABNF /// # ABNF
///
/// ```text /// ```text
/// Accept-Language = 1#( language-range [ weight ] ) /// Accept-Language = 1#( language-range [ weight ] )
/// language-range = <language-range, see [RFC4647], Section 2.1> /// language-range = (1*8ALPHA *("-" 1*8alphanum)) / "*"
/// alphanum = ALPHA / DIGIT
/// weight = OWS ";" OWS "q=" qvalue
/// qvalue = ( "0" [ "." 0*3DIGIT ] )
/// / ( "1" [ "." 0*3("0") ] )
/// ``` /// ```
/// ///
/// # Example values /// # Example Values
/// * `da, en-gb;q=0.8, en;q=0.7` /// - `da, en-gb;q=0.8, en;q=0.7`
/// * `en-us;q=1.0, en;q=0.5, fr` /// - `en-us;q=1.0, en;q=0.5, fr`
/// - `fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5`
/// ///
/// # Examples /// # Examples
///
/// ``` /// ```
/// use actix_web::HttpResponse; /// use actix_web::HttpResponse;
/// use actix_web::http::header::{AcceptLanguage, LanguageTag, qitem}; /// use actix_web::http::header::{AcceptLanguage, LanguageTag, qitem};
/// ///
/// let mut builder = HttpResponse::Ok(); /// let mut builder = HttpResponse::Ok();
/// let langtag = LanguageTag::parse("en-US").unwrap();
/// builder.insert_header( /// builder.insert_header(
/// AcceptLanguage(vec![ /// AcceptLanguage(vec![
/// qitem(langtag), /// qitem(LanguageTag::parse("en-US").unwrap())
/// ]) /// ])
/// ); /// );
/// ``` /// ```
@ -49,18 +52,144 @@ crate::http::header::common_header! {
/// ]) /// ])
/// ); /// );
/// ``` /// ```
(AcceptLanguage, ACCEPT_LANGUAGE) => (QualityItem<LanguageTag>)+ (AcceptLanguage, header::ACCEPT_LANGUAGE) => (QualityItem<AnyOrSome<LanguageTag>>)+
test_accept_language { parse_and_fmt_tests {
// From the RFC common_header_test!(
crate::http::header::common_header_test!(test1, vec![b"da, en-gb;q=0.8, en;q=0.7"]); example_from_rfc,
// Own test vec![b"da, en-gb;q=0.8, en;q=0.7"]
crate::http::header::common_header_test!( );
test2, vec![b"en-US, en; q=0.5, fr"],
common_header_test!(
not_ordered_by_weight,
vec![b"en-US, en; q=0.5, fr"],
Some(AcceptLanguage(vec![ Some(AcceptLanguage(vec![
qitem("en-US".parse().unwrap()), qitem("en-US".parse().unwrap()),
QualityItem::new("en".parse().unwrap(), q(500)), QualityItem::new("en".parse().unwrap(), q(500)),
qitem("fr".parse().unwrap()), qitem("fr".parse().unwrap()),
]))); ]))
);
common_header_test!(
has_wildcard,
vec![b"fr-CH, fr; q=0.9, en; q=0.8, de; q=0.7, *; q=0.5"],
Some(AcceptLanguage(vec![
qitem("fr-CH".parse().unwrap()),
QualityItem::new("fr".parse().unwrap(), q(900)),
QualityItem::new("en".parse().unwrap(), q(800)),
QualityItem::new("de".parse().unwrap(), q(700)),
QualityItem::new("*".parse().unwrap(), q(500)),
]))
);
}
}
impl AcceptLanguage {
/// Returns a sorted list of languages from highest to lowest precedence, accounting
/// for [q-factor weighting].
///
/// [q-factor weighting]: https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.2
pub fn ranked(&self) -> Vec<AnyOrSome<LanguageTag>> {
if self.0.is_empty() {
return vec![];
}
let mut types = self.0.clone();
// use stable sort so items with equal q-factor retain listed order
types.sort_by(|a, b| {
// sort by q-factor descending
b.quality.cmp(&a.quality)
});
types.into_iter().map(|qitem| qitem.item).collect()
}
/// Extracts the most preferable language, accounting for [q-factor weighting].
///
/// If no q-factors are provided, the first language is chosen. Note that items without
/// q-factors are given the maximum preference value.
///
/// As per the spec, returns [`AnyOrSome::Any`] if contained list is empty.
///
/// [q-factor weighting]: https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.2
pub fn preference(&self) -> AnyOrSome<LanguageTag> {
// PERF: creating a sorted list is not necessary
self.ranked().into_iter().next().unwrap_or(AnyOrSome::Any)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::http::header::*;
#[test]
fn ranking_precedence() {
let test = AcceptLanguage(vec![]);
assert!(test.ranked().is_empty());
let test = AcceptLanguage(vec![qitem("fr-CH".parse().unwrap())]);
assert_eq!(test.ranked(), vec!("fr-CH".parse().unwrap()));
let test = AcceptLanguage(vec![
QualityItem::new("fr".parse().unwrap(), q(900)),
QualityItem::new("fr-CH".parse().unwrap(), q(1000)),
QualityItem::new("en".parse().unwrap(), q(800)),
QualityItem::new("*".parse().unwrap(), q(500)),
QualityItem::new("de".parse().unwrap(), q(700)),
]);
assert_eq!(
test.ranked(),
vec![
"fr-CH".parse().unwrap(),
"fr".parse().unwrap(),
"en".parse().unwrap(),
"de".parse().unwrap(),
"*".parse().unwrap(),
]
);
let test = AcceptLanguage(vec![
qitem("fr".parse().unwrap()),
qitem("fr-CH".parse().unwrap()),
qitem("en".parse().unwrap()),
qitem("*".parse().unwrap()),
qitem("de".parse().unwrap()),
]);
assert_eq!(
test.ranked(),
vec![
"fr".parse().unwrap(),
"fr-CH".parse().unwrap(),
"en".parse().unwrap(),
"*".parse().unwrap(),
"de".parse().unwrap(),
]
);
}
#[test]
fn preference_selection() {
let test = AcceptLanguage(vec![
QualityItem::new("fr".parse().unwrap(), q(900)),
QualityItem::new("fr-CH".parse().unwrap(), q(1000)),
QualityItem::new("en".parse().unwrap(), q(800)),
QualityItem::new("*".parse().unwrap(), q(500)),
QualityItem::new("de".parse().unwrap(), q(700)),
]);
assert_eq!(test.preference(), AnyOrSome::Item("fr-CH".parse().unwrap()));
let test = AcceptLanguage(vec![
qitem("fr".parse().unwrap()),
qitem("fr-CH".parse().unwrap()),
qitem("en".parse().unwrap()),
qitem("*".parse().unwrap()),
qitem("de".parse().unwrap()),
]);
assert_eq!(test.preference(), AnyOrSome::Item("fr".parse().unwrap()));
let test = AcceptLanguage(vec![]);
assert_eq!(test.preference(), AnyOrSome::Any);
} }
} }

View File

@ -0,0 +1,70 @@
use std::{
fmt::{self, Write as _},
str,
};
/// A wrapper for types used in header values where wildcard (`*`) items are allowed but the
/// underlying type does not support them.
///
/// For example, we use the `language-tags` crate for the [`AcceptLanguage`](super::AcceptLanguage)
/// typed header but it does parse `*` successfully. On the other hand, the `mime` crate, used for
/// [`Accept`](super::Accept), has first-party support for wildcard items so this wrapper is not
/// used in those header types.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Hash)]
pub enum AnyOrSome<T> {
/// A wildcard value.
Any,
/// A valid `T`.
Item(T),
}
impl<T> AnyOrSome<T> {
/// Returns true if item is wildcard (`*`) variant.
pub fn is_any(&self) -> bool {
matches!(self, Self::Any)
}
/// Returns true if item is a valid item (`T`) variant.
pub fn is_item(&self) -> bool {
matches!(self, Self::Item(_))
}
/// Returns reference to value in `Item` variant, if it is set.
pub fn item(&self) -> Option<&T> {
match self {
AnyOrSome::Item(ref item) => Some(item),
AnyOrSome::Any => None,
}
}
/// Consumes the container, returning the value in the `Item` variant, if it is set.
pub fn into_item(self) -> Option<T> {
match self {
AnyOrSome::Item(item) => Some(item),
AnyOrSome::Any => None,
}
}
}
impl<T: fmt::Display> fmt::Display for AnyOrSome<T> {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
AnyOrSome::Any => f.write_char('*'),
AnyOrSome::Item(item) => fmt::Display::fmt(item, f),
}
}
}
impl<T: str::FromStr> str::FromStr for AnyOrSome<T> {
type Err = T::Err;
#[inline]
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s.trim() {
"*" => Ok(Self::Any),
other => other.parse().map(AnyOrSome::Item),
}
}
}

View File

@ -1,17 +1,18 @@
// TODO: replace with derive_more impl
macro_rules! common_header_deref { macro_rules! common_header_deref {
($from:ty => $to:ty) => { ($from:ty => $to:ty) => {
impl ::std::ops::Deref for $from { impl ::core::ops::Deref for $from {
type Target = $to; type Target = $to;
#[inline] #[inline]
fn deref(&self) -> &$to { fn deref(&self) -> &Self::Target {
&self.0 &self.0
} }
} }
impl ::std::ops::DerefMut for $from { impl ::core::ops::DerefMut for $from {
#[inline] #[inline]
fn deref_mut(&mut self) -> &mut $to { fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0 &mut self.0
} }
} }
@ -42,14 +43,19 @@ macro_rules! common_header_test {
let raw = $raw; let raw = $raw;
let a: Vec<Vec<u8>> = raw.iter().map(|x| x.to_vec()).collect(); let a: Vec<Vec<u8>> = raw.iter().map(|x| x.to_vec()).collect();
let mut req = test::TestRequest::default(); let mut req = test::TestRequest::default();
for item in a { for item in a {
req = req.insert_header((HeaderField::name(), item)).take(); req = req.insert_header((HeaderField::name(), item)).take();
} }
let req = req.finish(); let req = req.finish();
let value = HeaderField::parse(&req); let value = HeaderField::parse(&req);
let result = format!("{}", value.unwrap()); let result = format!("{}", value.unwrap());
let expected = String::from_utf8(raw[0].to_vec()).unwrap(); let expected = String::from_utf8(raw[0].to_vec()).unwrap();
let result_cmp: Vec<String> = result let result_cmp: Vec<String> = result
.to_ascii_lowercase() .to_ascii_lowercase()
.split(' ') .split(' ')
@ -60,9 +66,11 @@ macro_rules! common_header_test {
.split(' ') .split(' ')
.map(|x| x.to_owned()) .map(|x| x.to_owned())
.collect(); .collect();
assert_eq!(result_cmp.concat(), expected_cmp.concat()); assert_eq!(result_cmp.concat(), expected_cmp.concat());
} }
}; };
($id:ident, $raw:expr, $typed:expr) => { ($id:ident, $raw:expr, $typed:expr) => {
#[test] #[test]
fn $id() { fn $id() {
@ -76,8 +84,10 @@ macro_rules! common_header_test {
let req = req.finish(); let req = req.finish();
let val = HeaderField::parse(&req); let val = HeaderField::parse(&req);
let typed: Option<HeaderField> = $typed; let typed: Option<HeaderField> = $typed;
// Test parsing // Test parsing
assert_eq!(val.ok(), typed); assert_eq!(val.ok(), typed);
// Test formatting // Test formatting
if typed.is_some() { if typed.is_some() {
let raw = &($raw)[..]; let raw = &($raw)[..];
@ -111,37 +121,41 @@ macro_rules! common_header {
fn name() -> $crate::http::header::HeaderName { fn name() -> $crate::http::header::HeaderName {
$name $name
} }
#[inline] #[inline]
fn parse<T>(msg: &T) -> Result<Self, $crate::error::ParseError> fn parse<T: $crate::HttpMessage>(msg: &T) -> Result<Self, $crate::error::ParseError> {
where T: $crate::HttpMessage let headers = msg.headers().get_all(Self::name());
{ $crate::http::header::from_comma_delimited(headers).map($id)
$crate::http::header::from_comma_delimited(
msg.headers().get_all(Self::name())).map($id)
} }
} }
impl std::fmt::Display for $id {
impl ::core::fmt::Display for $id {
#[inline] #[inline]
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> ::std::fmt::Result { fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
$crate::http::header::fmt_comma_delimited(f, &self.0[..]) $crate::http::header::fmt_comma_delimited(f, &self.0[..])
} }
} }
impl $crate::http::header::IntoHeaderValue for $id { impl $crate::http::header::IntoHeaderValue for $id {
type Error = $crate::http::header::InvalidHeaderValue; type Error = $crate::http::header::InvalidHeaderValue;
fn try_into_value(self) -> Result<$crate::http::header::HeaderValue, Self::Error> { fn try_into_value(self) -> Result<$crate::http::header::HeaderValue, Self::Error> {
use std::fmt::Write; use ::core::fmt::Write;
let mut writer = $crate::http::header::Writer::new(); let mut writer = $crate::http::header::Writer::new();
let _ = write!(&mut writer, "{}", self); let _ = write!(&mut writer, "{}", self);
$crate::http::header::HeaderValue::from_maybe_shared(writer.take()) $crate::http::header::HeaderValue::from_maybe_shared(writer.take())
} }
} }
}; };
// List header, one or more items // List header, one or more items
($(#[$a:meta])*($id:ident, $name:expr) => ($item:ty)+) => { ($(#[$a:meta])*($id:ident, $name:expr) => ($item:ty)+) => {
$(#[$a])* $(#[$a])*
#[derive(Clone, Debug, PartialEq)] #[derive(Clone, Debug, PartialEq)]
pub struct $id(pub Vec<$item>); pub struct $id(pub Vec<$item>);
crate::http::header::common_header_deref!($id => Vec<$item>); crate::http::header::common_header_deref!($id => Vec<$item>);
impl $crate::http::header::Header for $id { impl $crate::http::header::Header for $id {
#[inline] #[inline]
fn name() -> $crate::http::header::HeaderName { fn name() -> $crate::http::header::HeaderName {
@ -155,48 +169,54 @@ macro_rules! common_header {
msg.headers().get_all(Self::name())).map($id) msg.headers().get_all(Self::name())).map($id)
} }
} }
impl std::fmt::Display for $id {
impl ::core::fmt::Display for $id {
#[inline] #[inline]
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
$crate::http::header::fmt_comma_delimited(f, &self.0[..]) $crate::http::header::fmt_comma_delimited(f, &self.0[..])
} }
} }
impl $crate::http::header::IntoHeaderValue for $id { impl $crate::http::header::IntoHeaderValue for $id {
type Error = $crate::http::header::InvalidHeaderValue; type Error = $crate::http::header::InvalidHeaderValue;
fn try_into_value(self) -> Result<$crate::http::header::HeaderValue, Self::Error> { fn try_into_value(self) -> Result<$crate::http::header::HeaderValue, Self::Error> {
use std::fmt::Write; use ::core::fmt::Write;
let mut writer = $crate::http::header::Writer::new(); let mut writer = $crate::http::header::Writer::new();
let _ = write!(&mut writer, "{}", self); let _ = write!(&mut writer, "{}", self);
$crate::http::header::HeaderValue::from_maybe_shared(writer.take()) $crate::http::header::HeaderValue::from_maybe_shared(writer.take())
} }
} }
}; };
// Single value header // Single value header
($(#[$a:meta])*($id:ident, $name:expr) => [$value:ty]) => { ($(#[$a:meta])*($id:ident, $name:expr) => [$value:ty]) => {
$(#[$a])* $(#[$a])*
#[derive(Clone, Debug, PartialEq)] #[derive(Clone, Debug, PartialEq)]
pub struct $id(pub $value); pub struct $id(pub $value);
crate::http::header::common_header_deref!($id => $value); crate::http::header::common_header_deref!($id => $value);
impl $crate::http::header::Header for $id { impl $crate::http::header::Header for $id {
#[inline] #[inline]
fn name() -> $crate::http::header::HeaderName { fn name() -> $crate::http::header::HeaderName {
$name $name
} }
#[inline] #[inline]
fn parse<T>(msg: &T) -> Result<Self, $crate::error::ParseError> fn parse<T: $crate::HttpMessage>(msg: &T) -> Result<Self, $crate::error::ParseError> {
where T: $crate::HttpMessage let header = msg.headers().get(Self::name());
{ $crate::http::header::from_one_raw_str(header).map($id)
$crate::http::header::from_one_raw_str(
msg.headers().get(Self::name())).map($id)
} }
} }
impl std::fmt::Display for $id {
impl ::core::fmt::Display for $id {
#[inline] #[inline]
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
std::fmt::Display::fmt(&self.0, f) ::core::fmt::Display::fmt(&self.0, f)
} }
} }
impl $crate::http::header::IntoHeaderValue for $id { impl $crate::http::header::IntoHeaderValue for $id {
type Error = $crate::http::header::InvalidHeaderValue; type Error = $crate::http::header::InvalidHeaderValue;
@ -205,6 +225,7 @@ macro_rules! common_header {
} }
} }
}; };
// List header, one or more items with "*" option // List header, one or more items with "*" option
($(#[$a:meta])*($id:ident, $name:expr) => {Any / ($item:ty)+}) => { ($(#[$a:meta])*($id:ident, $name:expr) => {Any / ($item:ty)+}) => {
$(#[$a])* $(#[$a])*
@ -215,42 +236,46 @@ macro_rules! common_header {
/// Only the listed items are a match /// Only the listed items are a match
Items(Vec<$item>), Items(Vec<$item>),
} }
impl $crate::http::header::Header for $id { impl $crate::http::header::Header for $id {
#[inline] #[inline]
fn name() -> $crate::http::header::HeaderName { fn name() -> $crate::http::header::HeaderName {
$name $name
} }
#[inline]
fn parse<T>(msg: &T) -> Result<Self, $crate::error::ParseError>
where T: $crate::HttpMessage
{
let any = msg.headers().get(Self::name()).and_then(|hdr| {
hdr.to_str().ok().and_then(|hdr| Some(hdr.trim() == "*"))});
if let Some(true) = any { #[inline]
fn parse<T: $crate::HttpMessage>(msg: &T) -> Result<Self, $crate::error::ParseError> {
let is_any = msg
.headers()
.get(Self::name())
.and_then(|hdr| hdr.to_str().ok())
.map(|hdr| hdr.trim() == "*");
if let Some(true) = is_any {
Ok($id::Any) Ok($id::Any)
} else { } else {
Ok($id::Items( let headers = msg.headers().get_all(Self::name());
$crate::http::header::from_comma_delimited( Ok($id::Items($crate::http::header::from_comma_delimited(headers)?))
msg.headers().get_all(Self::name()))?))
} }
} }
} }
impl std::fmt::Display for $id {
impl ::core::fmt::Display for $id {
#[inline] #[inline]
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
match *self { match *self {
$id::Any => f.write_str("*"), $id::Any => f.write_str("*"),
$id::Items(ref fields) => $crate::http::header::fmt_comma_delimited( $id::Items(ref fields) =>
f, &fields[..]) $crate::http::header::fmt_comma_delimited(f, &fields[..])
} }
} }
} }
impl $crate::http::header::IntoHeaderValue for $id { impl $crate::http::header::IntoHeaderValue for $id {
type Error = $crate::http::header::InvalidHeaderValue; type Error = $crate::http::header::InvalidHeaderValue;
fn try_into_value(self) -> Result<$crate::http::header::HeaderValue, Self::Error> { fn try_into_value(self) -> Result<$crate::http::header::HeaderValue, Self::Error> {
use std::fmt::Write; use ::core::fmt::Write;
let mut writer = $crate::http::header::Writer::new(); let mut writer = $crate::http::header::Writer::new();
let _ = write!(&mut writer, "{}", self); let _ = write!(&mut writer, "{}", self);
$crate::http::header::HeaderValue::from_maybe_shared(writer.take()) $crate::http::header::HeaderValue::from_maybe_shared(writer.take())

View File

@ -1,19 +1,57 @@
//! A Collection of Header implementations for common HTTP Headers. //! A Collection of Header implementations for common HTTP Headers.
//! //!
//! ## Mime //! ## Mime Types
//!
//! Several header fields use MIME values for their contents. Keeping with the strongly-typed theme, //! Several header fields use MIME values for their contents. Keeping with the strongly-typed theme,
//! the [mime] crate is used in such headers as [`ContentType`] and [`Accept`]. //! the [mime] crate is used in such headers as [`ContentType`] and [`Accept`].
use bytes::{Bytes, BytesMut};
use std::fmt; use std::fmt;
pub use self::accept_charset::AcceptCharset; use bytes::{Bytes, BytesMut};
// re-export from actix-http
// - header name / value types
// - relevant traits for converting to header name / value
// - all const header names
// - header map
// - the few typed headers from actix-http
// - header parsing utils
pub use actix_http::http::header::*; pub use actix_http::http::header::*;
mod accept_charset;
// mod accept_encoding;
mod accept;
mod accept_language;
mod allow;
mod any_or_some;
mod cache_control;
mod content_disposition;
mod content_language;
mod content_range;
mod content_type;
mod date;
mod encoding;
mod entity;
mod etag;
mod expires;
mod if_match;
mod if_modified_since;
mod if_none_match;
mod if_range;
mod if_unmodified_since;
mod last_modified;
mod macros;
// mod range;
#[cfg(test)]
pub(crate) use macros::common_header_test;
pub(crate) use macros::{common_header, common_header_deref, common_header_test_module};
pub use self::accept_charset::AcceptCharset;
//pub use self::accept_encoding::AcceptEncoding; //pub use self::accept_encoding::AcceptEncoding;
pub use self::accept::Accept; pub use self::accept::Accept;
pub use self::accept_language::AcceptLanguage; pub use self::accept_language::AcceptLanguage;
pub use self::allow::Allow; pub use self::allow::Allow;
pub use self::any_or_some::AnyOrSome;
pub use self::cache_control::{CacheControl, CacheDirective}; pub use self::cache_control::{CacheControl, CacheDirective};
pub use self::content_disposition::{ContentDisposition, DispositionParam, DispositionType}; pub use self::content_disposition::{ContentDisposition, DispositionParam, DispositionType};
pub use self::content_language::ContentLanguage; pub use self::content_language::ContentLanguage;
@ -31,10 +69,8 @@ pub use self::if_range::IfRange;
pub use self::if_unmodified_since::IfUnmodifiedSince; pub use self::if_unmodified_since::IfUnmodifiedSince;
pub use self::last_modified::LastModified; pub use self::last_modified::LastModified;
//pub use self::range::{Range, ByteRangeSpec}; //pub use self::range::{Range, ByteRangeSpec};
pub(crate) use actix_http::http::header::{
fmt_comma_delimited, from_comma_delimited, from_one_raw_str,
};
/// Format writer ([`fmt::Write`]) for a [`BytesMut`].
#[derive(Debug, Default)] #[derive(Debug, Default)]
struct Writer { struct Writer {
buf: BytesMut, buf: BytesMut,
@ -62,30 +98,3 @@ impl fmt::Write for Writer {
fmt::write(self, args) fmt::write(self, args)
} }
} }
mod accept_charset;
// mod accept_encoding;
mod accept;
mod accept_language;
mod allow;
mod cache_control;
mod content_disposition;
mod content_language;
mod content_range;
mod content_type;
mod date;
mod encoding;
mod entity;
mod etag;
mod expires;
mod if_match;
mod if_modified_since;
mod if_none_match;
mod if_range;
mod if_unmodified_since;
mod last_modified;
mod macros;
#[cfg(test)]
pub(crate) use macros::common_header_test;
pub(crate) use macros::{common_header, common_header_deref, common_header_test_module};