axol 0.2.0

Axol Web Framework
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

use std::{fmt, sync::Arc};

use axol_http::{
    header::TypedHeader, request::RequestPartsRef, typed_headers::AccessControlAllowOrigin,
};

use super::Any;

/// Holds configuration for how to set the [`Access-Control-Allow-Origin`][mdn] header.
///
/// See [`CorsLayer::allow_origin`] for more details.
///
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin
/// [`CorsLayer::allow_origin`]: super::CorsLayer::allow_origin
#[derive(Clone)]
#[must_use]
pub enum AllowOrigin {
    Const(String),
    List(Vec<String>),
    Predicate(super::CorsPredicate<bool>),
}

impl Default for AllowOrigin {
    fn default() -> Self {
        Self::List(Vec::new())
    }
}

impl AllowOrigin {
    /// Allow any origin by sending a wildcard (`*`)
    ///
    /// See [`CorsLayer::allow_origin`] for more details.
    ///
    /// [`CorsLayer::allow_origin`]: super::CorsLayer::allow_origin
    pub fn any() -> Self {
        Self::Const("*".to_string())
    }

    /// Set a single allowed origin
    ///
    /// See [`CorsLayer::allow_origin`] for more details.
    ///
    /// [`CorsLayer::allow_origin`]: super::CorsLayer::allow_origin
    pub fn exact(origin: impl Into<String>) -> Self {
        Self::Const(origin.into())
    }

    /// Set multiple allowed origins
    ///
    /// See [`CorsLayer::allow_origin`] for more details.
    ///
    /// # Panics
    ///
    /// If the iterator contains a wildcard (`*`).
    ///
    /// [`CorsLayer::allow_origin`]: super::CorsLayer::allow_origin
    pub fn list<S: Into<String>, I: IntoIterator<Item = S>>(origins: I) -> Self {
        let raw = origins.into_iter().map(|x| {
            let x = x.into();
            if x == "*" {
                panic!("Wildcard origin (`*`) cannot be passed to `AllowOrigin::list`. Use `AllowOrigin::any()` instead");
            }
            x
        }).collect::<Vec<_>>();
        Self::List(raw)
    }

    /// Set the allowed origins from a predicate
    ///
    /// See [`CorsLayer::allow_origin`] for more details.
    ///
    /// [`CorsLayer::allow_origin`]: super::CorsLayer::allow_origin
    pub fn predicate<F>(f: F) -> Self
    where
        F: Fn(&str, RequestPartsRef<'_>) -> bool + Send + Sync + 'static,
    {
        AllowOrigin::Predicate(Arc::new(f))
    }

    /// Allow any origin, by mirroring the request origin
    ///
    /// This is equivalent to
    /// [`AllowOrigin::predicate(|_, _| true)`][Self::predicate].
    ///
    /// See [`CorsLayer::allow_origin`] for more details.
    ///
    /// [`CorsLayer::allow_origin`]: super::CorsLayer::allow_origin
    pub fn mirror_request() -> Self {
        Self::predicate(|_, _| true)
    }

    #[allow(clippy::borrow_interior_mutable_const)]
    pub(super) fn is_wildcard(&self) -> bool {
        matches!(self, AllowOrigin::Const(x) if x == "*")
    }

    pub(super) fn to_header(
        &self,
        origin: Option<&str>,
        parts: RequestPartsRef<'_>,
    ) -> Option<AccessControlAllowOrigin> {
        match self {
            Self::Const(v) => Some(AccessControlAllowOrigin::decode(v).unwrap()),
            Self::List(list) => origin
                .filter(|o| list.iter().any(|x| x == *o))
                .map(|x| AccessControlAllowOrigin::decode(x).unwrap()),
            Self::Predicate(predicate) => origin
                .filter(|origin| predicate(origin, parts))
                .map(|x| AccessControlAllowOrigin::decode(x).unwrap()),
        }
    }
}

impl From<Any> for AllowOrigin {
    fn from(_: Any) -> Self {
        Self::any()
    }
}

impl fmt::Debug for AllowOrigin {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Const(arg0) => f.debug_tuple("Const").field(arg0).finish(),
            Self::List(arg0) => f.debug_tuple("List").field(arg0).finish(),
            Self::Predicate(_) => f.debug_tuple("Predicate").finish(),
        }
    }
}

impl From<String> for AllowOrigin {
    fn from(arr: String) -> Self {
        Self::Const(arr)
    }
}

impl From<&str> for AllowOrigin {
    fn from(arr: &str) -> Self {
        Self::Const(arr.into())
    }
}

impl<const N: usize> From<[&str; N]> for AllowOrigin {
    fn from(arr: [&str; N]) -> Self {
        Self::list(arr)
    }
}