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

use crate::headers::{Header, HeaderName, HeaderValue, Headers, EXPIRES};
use crate::utils::{fmt_http_date, parse_http_date};

use std::fmt::Debug;
use std::time::{Duration, SystemTime};

/// HTTP `Expires` header
///
/// # Specifications
///
/// - [RFC 7234, section 5.3: Expires](https://tools.ietf.org/html/rfc7234#section-5.3)
///
/// # Examples
///
/// ```
/// # fn main() -> http_types::Result<()> {
/// #
/// use http_types::Response;
/// use http_types::cache::Expires;
/// use std::time::{SystemTime, Duration};
///
/// let time = SystemTime::now() + Duration::from_secs(5 * 60);
/// let expires = Expires::new_at(time);
///
/// let mut res = Response::new(200);
/// res.insert_header(&expires, &expires);
///
/// let expires = Expires::from_headers(res)?.unwrap();
///
/// // HTTP dates only have second-precision.
/// let elapsed = time.duration_since(expires.expiration())?;
/// assert_eq!(elapsed.as_secs(), 0);
/// #
/// # Ok(()) }
/// ```
#[derive(Debug, Ord, PartialOrd, Eq, PartialEq)]
pub struct Expires {
    instant: SystemTime,
}

impl Expires {
    /// Create a new instance of `Expires`.
    pub fn new(dur: Duration) -> Self {
        let instant = SystemTime::now() + dur;
        Self { instant }
    }

    /// Create a new instance of `Expires` from secs.
    pub fn new_at(instant: SystemTime) -> Self {
        Self { instant }
    }

    /// Get the expiration time.
    pub fn expiration(&self) -> SystemTime {
        self.instant
    }

    /// Create an instance of `Expires` from a `Headers` instance.
    pub fn from_headers(headers: impl AsRef<Headers>) -> crate::Result<Option<Self>> {
        let headers = match headers.as_ref().get(EXPIRES) {
            Some(headers) => headers,
            None => return Ok(None),
        };

        // If we successfully parsed the header then there's always at least one
        // entry. We want the last entry.
        let header = headers.iter().last().unwrap();

        let instant = parse_http_date(header.as_str())?;
        Ok(Some(Self { instant }))
    }
}

impl Header for Expires {
    fn header_name(&self) -> HeaderName {
        EXPIRES
    }
    fn header_value(&self) -> HeaderValue {
        let output = fmt_http_date(self.instant);

        // SAFETY: the internal string is validated to be ASCII.
        unsafe { HeaderValue::from_bytes_unchecked(output.into()) }
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::headers::Headers;

    #[test]
    fn smoke() -> crate::Result<()> {
        let time = SystemTime::now() + Duration::from_secs(5 * 60);
        let expires = Expires::new_at(time);

        let mut headers = Headers::new();
        expires.apply_header(&mut headers);

        let expires = Expires::from_headers(headers)?.unwrap();

        // HTTP dates only have second-precision
        let elapsed = time.duration_since(expires.expiration())?;
        assert_eq!(elapsed.as_secs(), 0);
        Ok(())
    }

    #[test]
    fn bad_request_on_parse_error() {
        let mut headers = Headers::new();
        headers.insert(EXPIRES, "<nori ate the tag. yum.>");
        let err = Expires::from_headers(headers).unwrap_err();
        assert_eq!(err.status(), 400);
    }
}