use std::fmt; use std::str::FromStr; use header::{Header, HeaderFormat}; use header::parsing::{from_one_comma_delimited, fmt_comma_delimited}; /// `Cache-Control` header, defined in [RFC7234](https://tools.ietf.org/html/rfc7234#section-5.2) /// /// The `Cache-Control` header field is used to specify directives for /// caches along the request/response chain. Such cache directives are /// unidirectional in that the presence of a directive in a request does /// not imply that the same directive is to be given in the response. /// /// # ABNF /// ```plain /// Cache-Control = 1#cache-directive /// cache-directive = token [ "=" ( token / quoted-string ) ] /// ``` /// /// # Example values /// * `no-cache` /// * `private, community="UCI"` /// * `max-age=30` /// /// # Examples /// ``` /// use hyper::header::{Headers, CacheControl, CacheDirective}; /// /// let mut headers = Headers::new(); /// headers.set( /// CacheControl(vec![CacheDirective::MaxAge(86400u32)]) /// ); /// ``` /// ``` /// use hyper::header::{Headers, CacheControl, CacheDirective}; /// /// let mut headers = Headers::new(); /// headers.set( /// CacheControl(vec![ /// CacheDirective::NoCache, /// CacheDirective::Private, /// CacheDirective::MaxAge(360u32), /// CacheDirective::Extension("foo".to_owned(), /// Some("bar".to_owned())), /// ]) /// ); /// ``` #[derive(PartialEq, Clone, Debug)] pub struct CacheControl(pub Vec); __hyper__deref!(CacheControl => Vec); impl Header for CacheControl { fn header_name() -> &'static str { "Cache-Control" } fn parse_header(raw: &[Vec]) -> ::Result { let directives = raw.iter() .filter_map(|line| from_one_comma_delimited(&line[..]).ok()) .collect::>>() .concat(); if !directives.is_empty() { Ok(CacheControl(directives)) } else { Err(::Error::Header) } } } impl HeaderFormat for CacheControl { fn fmt_header(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt_comma_delimited(f, &self[..]) } } /// CacheControl contains a list of these directives. #[derive(PartialEq, Clone, Debug)] pub enum CacheDirective { /// "no-cache" NoCache, /// "no-store" NoStore, /// "no-transform" NoTransform, /// "only-if-cached" OnlyIfCached, // request directives /// "max-age=delta" MaxAge(u32), /// "max-stale=delta" MaxStale(u32), /// "min-fresh=delta" MinFresh(u32), // response directives /// "must-revalidate" MustRevalidate, /// "public" Public, /// "private" Private, /// "proxy-revalidate" ProxyRevalidate, /// "s-maxage=delta" SMaxAge(u32), /// Extension directives. Optionally include an argument. Extension(String, Option) } impl fmt::Display for CacheDirective { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { use self::CacheDirective::*; fmt::Display::fmt(match *self { NoCache => "no-cache", NoStore => "no-store", NoTransform => "no-transform", OnlyIfCached => "only-if-cached", MaxAge(secs) => return write!(f, "max-age={}", secs), MaxStale(secs) => return write!(f, "max-stale={}", secs), MinFresh(secs) => return write!(f, "min-fresh={}", secs), MustRevalidate => "must-revalidate", Public => "public", Private => "private", ProxyRevalidate => "proxy-revalidate", SMaxAge(secs) => return write!(f, "s-maxage={}", secs), Extension(ref name, None) => &name[..], Extension(ref name, Some(ref arg)) => return write!(f, "{}={}", name, arg), }, f) } } impl FromStr for CacheDirective { type Err = Option<::Err>; fn from_str(s: &str) -> Result::Err>> { use self::CacheDirective::*; match s { "no-cache" => Ok(NoCache), "no-store" => Ok(NoStore), "no-transform" => Ok(NoTransform), "only-if-cached" => Ok(OnlyIfCached), "must-revalidate" => Ok(MustRevalidate), "public" => Ok(Public), "private" => Ok(Private), "proxy-revalidate" => Ok(ProxyRevalidate), "" => Err(None), _ => match s.find('=') { Some(idx) if idx+1 < s.len() => match (&s[..idx], (&s[idx+1..]).trim_matches('"')) { ("max-age" , secs) => secs.parse().map(MaxAge).map_err(Some), ("max-stale", secs) => secs.parse().map(MaxStale).map_err(Some), ("min-fresh", secs) => secs.parse().map(MinFresh).map_err(Some), ("s-maxage", secs) => secs.parse().map(SMaxAge).map_err(Some), (left, right) => Ok(Extension(left.to_owned(), Some(right.to_owned()))) }, Some(_) => Err(None), None => Ok(Extension(s.to_owned(), None)) } } } } #[cfg(test)] mod tests { use header::Header; use super::*; #[test] fn test_parse_multiple_headers() { let cache = Header::parse_header(&[b"no-cache".to_vec(), b"private".to_vec()]); assert_eq!(cache.ok(), Some(CacheControl(vec![CacheDirective::NoCache, CacheDirective::Private]))) } #[test] fn test_parse_argument() { let cache = Header::parse_header(&[b"max-age=100, private".to_vec()]); assert_eq!(cache.ok(), Some(CacheControl(vec![CacheDirective::MaxAge(100), CacheDirective::Private]))) } #[test] fn test_parse_quote_form() { let cache = Header::parse_header(&[b"max-age=\"200\"".to_vec()]); assert_eq!(cache.ok(), Some(CacheControl(vec![CacheDirective::MaxAge(200)]))) } #[test] fn test_parse_extension() { let cache = Header::parse_header(&[b"foo, bar=baz".to_vec()]); assert_eq!(cache.ok(), Some(CacheControl(vec![ CacheDirective::Extension("foo".to_owned(), None), CacheDirective::Extension("bar".to_owned(), Some("baz".to_owned()))]))) } #[test] fn test_parse_bad_syntax() { let cache: ::Result = Header::parse_header(&[b"foo=".to_vec()]); assert_eq!(cache.ok(), None) } } bench_header!(normal, CacheControl, { vec![b"no-cache, private".to_vec(), b"max-age=100".to_vec()] });