Update http header range

This commit is contained in:
RideWindX 2021-07-12 19:56:28 +08:00
parent 293c52c3ef
commit ec6ab94e8a
2 changed files with 81 additions and 73 deletions

View File

@ -30,7 +30,7 @@ pub use self::if_none_match::IfNoneMatch;
pub use self::if_range::IfRange; 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::{ByteRangeSpec, Range};
pub(crate) use actix_http::http::header::{ pub(crate) use actix_http::http::header::{
fmt_comma_delimited, from_comma_delimited, from_one_raw_str, fmt_comma_delimited, from_comma_delimited, from_one_raw_str,
}; };
@ -84,6 +84,7 @@ mod if_none_match;
mod if_range; mod if_range;
mod if_unmodified_since; mod if_unmodified_since;
mod last_modified; mod last_modified;
mod range;
mod macros; mod macros;
#[cfg(test)] #[cfg(test)]

View File

@ -1,8 +1,13 @@
use std::fmt::{self, Display}; use std::fmt::{self, Display, Write};
use std::str::FromStr; use std::str::FromStr;
use super::parsing::from_one_raw_str; use super::{
use super::{Header, Raw}; from_one_raw_str, Header, HeaderName, HeaderValue, IntoHeaderValue, InvalidHeaderValue,
Writer,
};
use actix_http::error::ParseError;
use actix_http::header;
use actix_http::HttpMessage;
/// `Range` header, defined in [RFC7233](https://tools.ietf.org/html/rfc7233#section-3.1) /// `Range` header, defined in [RFC7233](https://tools.ietf.org/html/rfc7233#section-3.1)
/// ///
@ -39,25 +44,22 @@ use super::{Header, Raw};
/// # Examples /// # Examples
/// ///
/// ``` /// ```
/// use hyper::header::{Headers, Range, ByteRangeSpec}; /// use actix_web::http::header::{Range, ByteRangeSpec};
/// use actix_web::HttpResponse;
/// ///
/// let mut headers = Headers::new(); /// let mut builder = HttpResponse::Ok();
/// headers.set(Range::Bytes( /// builder.insert_header(Range::Bytes(
/// vec![ByteRangeSpec::FromTo(1, 100), ByteRangeSpec::AllFrom(200)] /// vec![ByteRangeSpec::FromTo(1, 100), ByteRangeSpec::AllFrom(200)]
/// )); /// ));
/// /// builder.insert_header(
/// headers.clear(); /// Range::Unregistered("letters".to_owned(), "a-f".to_owned())
/// headers.set(Range::Unregistered("letters".to_owned(), "a-f".to_owned())); /// );
/// ``` /// builder.insert_header(
/// /// Range::bytes(1, 100)
/// ``` /// );
/// use hyper::header::{Headers, Range}; /// builder.insert_header(
/// /// Range::bytes_multi(vec![(1, 100), (200, 300)])
/// let mut headers = Headers::new(); /// );
/// headers.set(Range::bytes(1, 100));
///
/// headers.clear();
/// headers.set(Range::bytes_multi(vec![(1, 100), (200, 300)]));
/// ``` /// ```
#[derive(PartialEq, Clone, Debug)] #[derive(PartialEq, Clone, Debug)]
pub enum Range { pub enum Range {
@ -170,7 +172,7 @@ impl Range {
} }
impl fmt::Display for ByteRangeSpec { impl fmt::Display for ByteRangeSpec {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match *self { match *self {
ByteRangeSpec::FromTo(from, to) => write!(f, "{}-{}", from, to), ByteRangeSpec::FromTo(from, to) => write!(f, "{}-{}", from, to),
ByteRangeSpec::Last(pos) => write!(f, "-{}", pos), ByteRangeSpec::Last(pos) => write!(f, "-{}", pos),
@ -180,7 +182,7 @@ impl fmt::Display for ByteRangeSpec {
} }
impl fmt::Display for Range { impl fmt::Display for Range {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match *self { match *self {
Range::Bytes(ref ranges) => { Range::Bytes(ref ranges) => {
write!(f, "bytes=")?; write!(f, "bytes=")?;
@ -201,49 +203,47 @@ impl fmt::Display for Range {
} }
impl FromStr for Range { impl FromStr for Range {
type Err = ::Error; type Err = ParseError;
fn from_str(s: &str) -> ::Result<Range> { fn from_str(s: &str) -> Result<Range, ParseError> {
let mut iter = s.splitn(2, '='); let mut iter = s.splitn(2, '=');
match (iter.next(), iter.next()) { match (iter.next(), iter.next()) {
(Some("bytes"), Some(ranges)) => { (Some("bytes"), Some(ranges)) => {
let ranges = from_comma_delimited(ranges); let ranges = from_comma_delimited(ranges);
if ranges.is_empty() { if ranges.is_empty() {
return Err(::Error::Header); return Err(ParseError::Header);
} }
Ok(Range::Bytes(ranges)) Ok(Range::Bytes(ranges))
} }
(Some(unit), Some(range_str)) if unit != "" && range_str != "" => { (Some(unit), Some(range_str)) if unit != "" && range_str != "" => {
Ok(Range::Unregistered(unit.to_owned(), range_str.to_owned())) Ok(Range::Unregistered(unit.to_owned(), range_str.to_owned()))
} }
_ => Err(::Error::Header), _ => Err(ParseError::Header),
} }
} }
} }
impl FromStr for ByteRangeSpec { impl FromStr for ByteRangeSpec {
type Err = ::Error; type Err = ParseError;
fn from_str(s: &str) -> ::Result<ByteRangeSpec> { fn from_str(s: &str) -> Result<ByteRangeSpec, ParseError> {
let mut parts = s.splitn(2, '-'); let mut parts = s.splitn(2, '-');
match (parts.next(), parts.next()) { match (parts.next(), parts.next()) {
(Some(""), Some(end)) => end (Some(""), Some(end)) => end
.parse() .parse()
.or(Err(::Error::Header)) .or(Err(ParseError::Header))
.map(ByteRangeSpec::Last), .map(ByteRangeSpec::Last),
(Some(start), Some("")) => start (Some(start), Some("")) => start
.parse() .parse()
.or(Err(::Error::Header)) .or(Err(ParseError::Header))
.map(ByteRangeSpec::AllFrom), .map(ByteRangeSpec::AllFrom),
(Some(start), Some(end)) => match (start.parse(), end.parse()) { (Some(start), Some(end)) => match (start.parse(), end.parse()) {
(Ok(start), Ok(end)) if start <= end => { (Ok(start), Ok(end)) if start <= end => Ok(ByteRangeSpec::FromTo(start, end)),
Ok(ByteRangeSpec::FromTo(start, end)) _ => Err(ParseError::Header),
}
_ => Err(::Error::Header),
}, },
_ => Err(::Error::Header), _ => Err(ParseError::Header),
} }
} }
} }
@ -259,35 +259,48 @@ fn from_comma_delimited<T: FromStr>(s: &str) -> Vec<T> {
} }
impl Header for Range { impl Header for Range {
fn header_name() -> &'static str { fn name() -> HeaderName {
static NAME: &'static str = "Range"; header::RANGE
NAME
} }
fn parse_header(raw: &Raw) -> ::Result<Range> { #[inline]
from_one_raw_str(raw) fn parse<T: HttpMessage>(msg: &T) -> Result<Self, ParseError> {
from_one_raw_str(msg.headers().get(&header::RANGE))
} }
}
fn fmt_header(&self, f: &mut ::header::Formatter) -> fmt::Result { impl IntoHeaderValue for Range {
f.fmt_line(self) type Error = InvalidHeaderValue;
fn try_into_value(self) -> Result<HeaderValue, Self::Error> {
let mut writer = Writer::new();
let _ = write!(&mut writer, "{}", self);
HeaderValue::from_maybe_shared(writer.take())
} }
} }
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
use actix_http::test::TestRequest;
use actix_http::Request;
fn req(s: &str) -> Request {
TestRequest::default()
.insert_header((header::RANGE, s))
.finish()
}
#[test] #[test]
fn test_parse_bytes_range_valid() { fn test_parse_bytes_range_valid() {
let r: Range = Header::parse_header(&"bytes=1-100".into()).unwrap(); let r: Range = Header::parse(&req("bytes=1-100")).unwrap();
let r2: Range = Header::parse_header(&"bytes=1-100,-".into()).unwrap(); let r2: Range = Header::parse(&req("bytes=1-100,-")).unwrap();
let r3 = Range::bytes(1, 100); let r3 = Range::bytes(1, 100);
assert_eq!(r, r2); assert_eq!(r, r2);
assert_eq!(r2, r3); assert_eq!(r2, r3);
let r: Range = Header::parse_header(&"bytes=1-100,200-".into()).unwrap(); let r: Range = Header::parse(&req("bytes=1-100,200-")).unwrap();
let r2: Range = let r2: Range = Header::parse(&req("bytes= 1-100 , 101-xxx, 200- ")).unwrap();
Header::parse_header(&"bytes= 1-100 , 101-xxx, 200- ".into()).unwrap();
let r3 = Range::Bytes(vec![ let r3 = Range::Bytes(vec![
ByteRangeSpec::FromTo(1, 100), ByteRangeSpec::FromTo(1, 100),
ByteRangeSpec::AllFrom(200), ByteRangeSpec::AllFrom(200),
@ -295,8 +308,8 @@ mod tests {
assert_eq!(r, r2); assert_eq!(r, r2);
assert_eq!(r2, r3); assert_eq!(r2, r3);
let r: Range = Header::parse_header(&"bytes=1-100,-100".into()).unwrap(); let r: Range = Header::parse(&req("bytes=1-100,-100")).unwrap();
let r2: Range = Header::parse_header(&"bytes=1-100, ,,-100".into()).unwrap(); let r2: Range = Header::parse(&req("bytes=1-100, ,,-100")).unwrap();
let r3 = Range::Bytes(vec![ let r3 = Range::Bytes(vec![
ByteRangeSpec::FromTo(1, 100), ByteRangeSpec::FromTo(1, 100),
ByteRangeSpec::Last(100), ByteRangeSpec::Last(100),
@ -304,71 +317,65 @@ mod tests {
assert_eq!(r, r2); assert_eq!(r, r2);
assert_eq!(r2, r3); assert_eq!(r2, r3);
let r: Range = Header::parse_header(&"custom=1-100,-100".into()).unwrap(); let r: Range = Header::parse(&req("custom=1-100,-100")).unwrap();
let r2 = Range::Unregistered("custom".to_owned(), "1-100,-100".to_owned()); let r2 = Range::Unregistered("custom".to_owned(), "1-100,-100".to_owned());
assert_eq!(r, r2); assert_eq!(r, r2);
} }
#[test] #[test]
fn test_parse_unregistered_range_valid() { fn test_parse_unregistered_range_valid() {
let r: Range = Header::parse_header(&"custom=1-100,-100".into()).unwrap(); let r: Range = Header::parse(&req("custom=1-100,-100")).unwrap();
let r2 = Range::Unregistered("custom".to_owned(), "1-100,-100".to_owned()); let r2 = Range::Unregistered("custom".to_owned(), "1-100,-100".to_owned());
assert_eq!(r, r2); assert_eq!(r, r2);
let r: Range = Header::parse_header(&"custom=abcd".into()).unwrap(); let r: Range = Header::parse(&req("custom=abcd")).unwrap();
let r2 = Range::Unregistered("custom".to_owned(), "abcd".to_owned()); let r2 = Range::Unregistered("custom".to_owned(), "abcd".to_owned());
assert_eq!(r, r2); assert_eq!(r, r2);
let r: Range = Header::parse_header(&"custom=xxx-yyy".into()).unwrap(); let r: Range = Header::parse(&req("custom=xxx-yyy")).unwrap();
let r2 = Range::Unregistered("custom".to_owned(), "xxx-yyy".to_owned()); let r2 = Range::Unregistered("custom".to_owned(), "xxx-yyy".to_owned());
assert_eq!(r, r2); assert_eq!(r, r2);
} }
#[test] #[test]
fn test_parse_invalid() { fn test_parse_invalid() {
let r: ::Result<Range> = Header::parse_header(&"bytes=1-a,-".into()); let r: Result<Range, ParseError> = Header::parse(&req("bytes=1-a,-"));
assert_eq!(r.ok(), None); assert_eq!(r.ok(), None);
let r: ::Result<Range> = Header::parse_header(&"bytes=1-2-3".into()); let r: Result<Range, ParseError> = Header::parse(&req("bytes=1-2-3"));
assert_eq!(r.ok(), None); assert_eq!(r.ok(), None);
let r: ::Result<Range> = Header::parse_header(&"abc".into()); let r: Result<Range, ParseError> = Header::parse(&req("abc"));
assert_eq!(r.ok(), None); assert_eq!(r.ok(), None);
let r: ::Result<Range> = Header::parse_header(&"bytes=1-100=".into()); let r: Result<Range, ParseError> = Header::parse(&req("bytes=1-100="));
assert_eq!(r.ok(), None); assert_eq!(r.ok(), None);
let r: ::Result<Range> = Header::parse_header(&"bytes=".into()); let r: Result<Range, ParseError> = Header::parse(&req("bytes="));
assert_eq!(r.ok(), None); assert_eq!(r.ok(), None);
let r: ::Result<Range> = Header::parse_header(&"custom=".into()); let r: Result<Range, ParseError> = Header::parse(&req("custom="));
assert_eq!(r.ok(), None); assert_eq!(r.ok(), None);
let r: ::Result<Range> = Header::parse_header(&"=1-100".into()); let r: Result<Range, ParseError> = Header::parse(&req("=1-100"));
assert_eq!(r.ok(), None); assert_eq!(r.ok(), None);
} }
#[test] #[test]
fn test_fmt() { fn test_fmt() {
use header::Headers; let range = Range::Bytes(vec![
let mut headers = Headers::new();
headers.set(Range::Bytes(vec![
ByteRangeSpec::FromTo(0, 1000), ByteRangeSpec::FromTo(0, 1000),
ByteRangeSpec::AllFrom(2000), ByteRangeSpec::AllFrom(2000),
])); ]);
assert_eq!(&headers.to_string(), "Range: bytes=0-1000,2000-\r\n"); assert_eq!(&range.to_string(), "bytes=0-1000,2000-");
headers.clear(); let range = Range::Bytes(vec![]);
headers.set(Range::Bytes(vec![]));
assert_eq!(&headers.to_string(), "Range: bytes=\r\n"); assert_eq!(&range.to_string(), "bytes=");
headers.clear(); let range = Range::Unregistered("custom".to_owned(), "1-xxx".to_owned());
headers.set(Range::Unregistered("custom".to_owned(), "1-xxx".to_owned()));
assert_eq!(&headers.to_string(), "Range: custom=1-xxx\r\n"); assert_eq!(&range.to_string(), "custom=1-xxx");
} }
#[test] #[test]