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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
use crate::processor::{ProcessIncomingError, Processor};
use crate::request::CookiesForName;
use crate::RequestCookie;
use std::borrow::Cow;
use std::collections::HashMap;

#[derive(Default, Debug, Clone)]
/// A collection of [`RequestCookie`]s attached to an HTTP request using the `Cookie` header.
pub struct RequestCookies<'c> {
    /// Invariant: the `Vec` for a given `name` is never empty.
    cookies: HashMap<Cow<'c, str>, Vec<Cow<'c, str>>>,
}

impl<'c> RequestCookies<'c> {
    /// Creates a new, empty [`RequestCookies`] map.
    pub fn new() -> RequestCookies<'c> {
        Default::default()
    }

    /// Inserts a new [`RequestCookie`] into `self`.
    ///
    /// If a cookie with the same name already exists, **the new value is appended
    /// to the existing value list**.
    ///
    /// If you want to replace the existing value list for a given name, use the
    /// [`RequestCookies::replace()`] method.
    ///
    /// # Return value
    ///
    /// Returns `true` if [`RequestCookies`] contained one or more cookies with the same name.
    /// `false` otherwise.
    ///
    /// # Example
    ///
    /// ```rust
    /// use biscotti::{RequestCookie, RequestCookies};
    ///
    /// let mut cookies = RequestCookies::new();
    /// cookies.append(RequestCookie::new("name", "value1"));
    /// assert_eq!(cookies.get("name").unwrap().value(), "value1");
    ///
    /// // A new cookie with the same name: its value is appended to
    /// // the existing value list for `name`.
    /// cookies.append(RequestCookie::new("name", "value2"));
    /// // `get` keeps returning the first value.
    /// assert_eq!(cookies.get("name").unwrap().value(), "value1");
    /// // Use `get_all` to get all values for a given name.
    /// let mut c = cookies.get_all("name").unwrap();
    /// assert_eq!(c.next().unwrap().value(), "value1");
    /// assert_eq!(c.next().unwrap().value(), "value2");
    /// assert_eq!(c.next(), None);
    /// ```
    pub fn append<C>(&mut self, cookie: C) -> bool
    where
        C: Into<RequestCookie<'c>>,
    {
        let cookie = cookie.into();
        let RequestCookie { name, value } = cookie;

        let output = self.cookies.contains_key(&name);

        self.cookies.entry(name).or_default().push(value);

        output
    }

    /// Inserts a new [`RequestCookie`] into `self`.
    ///
    /// If a cookie with the same name already exists, **the existing value
    /// list is discarded and replaced with the new value**.  
    ///
    /// If you want to append a new value to the existing value list, use
    /// [`RequestCookies::append()`].
    ///
    /// # Return value
    ///
    /// Returns `true` if [`RequestCookies`] contained one or more cookies with the same name.
    /// `false` otherwise.
    ///
    /// # Example
    ///
    /// ```rust
    /// use biscotti::{RequestCookie, RequestCookies};
    ///
    /// let mut cookies = RequestCookies::new();
    /// cookies.replace(RequestCookie::new("name", "value1"));
    ///
    /// assert_eq!(cookies.get("name").unwrap().value(), "value1");
    ///
    /// // A new cookie with the same name: its value replaces
    /// // the existing value list for `name`.
    /// cookies.replace(RequestCookie::new("name", "value2"));
    ///
    /// assert_eq!(cookies.get("name").unwrap().value(), "value2");
    /// let mut values = cookies.get_all("name").unwrap().values();
    /// assert_eq!(values.next(), Some("value2"));
    /// assert_eq!(values.next(), None);
    /// ```
    pub fn replace<C>(&mut self, cookie: C) -> bool
    where
        C: Into<RequestCookie<'c>>,
    {
        let cookie = cookie.into();
        let RequestCookie { name, value } = cookie;
        self.cookies.insert(name, vec![value]).is_some()
    }

    /// Get a cookie by name.
    ///
    /// If there are multiple cookie values associated to the name, this method returns the
    /// first one.
    /// If you want to get all cookie values for a given name, use [`RequestCookies::get_all()`].
    ///
    /// # Example
    ///
    /// ```rust
    /// use biscotti::{RequestCookie, RequestCookies};
    ///
    /// let mut cookies = RequestCookies::new();
    /// cookies.append(RequestCookie::new("name", "value1"));
    /// assert_eq!(cookies.get("name").unwrap().value(), "value1");
    ///
    /// // A new cookie with the same name: its value is appended to
    /// // the existing value list for `name`.
    /// cookies.append(RequestCookie::new("name", "value2"));
    ///
    /// // `get` keeps returning the first value.
    /// assert_eq!(cookies.get("name").unwrap().value(), "value1");
    /// // `get_all` returns all values.
    /// let mut values = cookies.get_all("name").unwrap().values();
    /// assert_eq!(values.next(), Some("value1"));
    /// assert_eq!(values.next(), Some("value2"));
    /// assert_eq!(values.next(), None);
    /// ```
    pub fn get(&self, name: &str) -> Option<RequestCookie<'c>> {
        self.cookies.get_key_value(name).map(|(name, v)| {
            let first = v.first().unwrap();
            RequestCookie::new(name.clone(), first.clone())
        })
    }

    /// Get all cookie values for a given cookie name.  
    /// If there are no cookies with the given name, the method returns `None`.
    ///
    /// If you want to get the first cookie value for a given name, use the
    /// [`RequestCookies::get()`] method.
    ///
    /// # Example
    ///
    /// ```rust
    /// use biscotti::{RequestCookie, RequestCookies};
    ///
    /// let mut cookies = RequestCookies::new();
    /// cookies.append(RequestCookie::new("name", "value1"));
    /// assert_eq!(cookies.get("name").unwrap().value(), "value1");
    ///
    /// // A new cookie with the same name: its value is appended to
    /// // the existing value list for `name`.
    /// cookies.append(RequestCookie::new("name", "value2"));
    ///
    /// // `get` keeps returning the first value.
    /// assert_eq!(cookies.get("name").unwrap().value(), "value1");
    /// // `get_all` returns all values.
    /// let mut values = cookies.get_all("name").unwrap().values();
    /// assert_eq!(values.next(), Some("value1"));
    /// assert_eq!(values.next(), Some("value2"));
    /// assert_eq!(values.next(), None);
    /// ```
    pub fn get_all(&self, name: &str) -> Option<CookiesForName<'_, 'c>> {
        self.cookies.get_key_value(name).map(|(name, v)| {
            let iter = v.iter();
            CookiesForName {
                iter,
                name: name.clone(),
            }
        })
    }

    /// Parse a `Cookie` header value into a [`RequestCookies`] map.
    pub fn parse_header(
        header: &'c str,
        policy: &Processor,
    ) -> Result<RequestCookies<'c>, ParseError> {
        let mut cookies = RequestCookies::new();
        for cookie in header.split(';') {
            if cookie.chars().all(char::is_whitespace) {
                continue;
            }

            let (name, value) = match cookie.split_once('=') {
                Some((name, value)) => (name.trim(), value.trim()),
                None => return Err(ParseError::MissingPair),
            };

            if name.is_empty() {
                return Err(ParseError::EmptyName);
            }

            let cookie = policy.process_incoming(name, value)?;

            cookies.append(cookie);
        }
        Ok(cookies)
    }
}

#[derive(Debug, thiserror::Error)]
/// The error returned by [`RequestCookies::parse_header()`].
pub enum ParseError {
    #[error("Expected a name-value pair, but no `=` was found")]
    MissingPair,
    #[error("Cookie name is empty")]
    EmptyName,
    #[error(transparent)]
    ProcessingError(#[from] ProcessIncomingError),
}

#[cfg(test)]
mod tests {
    use crate::config::Config;
    use crate::errors::ParseError::{EmptyName, MissingPair};
    use crate::processor::DecodingError;
    use crate::{
        errors::{ParseError, ProcessIncomingError},
        Processor, RequestCookies,
    };

    /// A helper macro for our testing purposes.
    ///
    /// E.g. `cookies!("name" => "value", "other" => "key")` expands to:
    ///
    /// ```rust
    /// use biscotti::{RequestCookie, RequestCookies};
    ///
    /// {
    ///     let mut cookies = RequestCookies::new();
    ///     cookies.append(RequestCookie::new("name", "value"));
    ///     cookies.append(RequestCookie::new("other", "key"));
    ///     Ok(cookies)
    /// }
    /// ```
    macro_rules! cookies {
        ($($name:expr => $value:expr),* $(,)?) => {
            {
                use crate::RequestCookies;
                #[allow(unused_imports)]
                use crate::RequestCookie;

                #[allow(unused_mut)]
                let mut cookies = RequestCookies::new();
                $(
                    cookies.append(RequestCookie::new($name, $value));
                )*
                Ok(cookies)
            }
        };
    }

    #[track_caller]
    fn check_case(
        string: &str,
        processor: &Processor,
        expected: Result<RequestCookies, ParseError>,
    ) {
        match RequestCookies::parse_header(string, processor) {
            Ok(actual) => {
                let expected =
                    expected.unwrap_or_else(|_| panic!("Expected a success for {string}"));
                for (name, value) in expected.cookies {
                    let values: Vec<_> = actual
                        .get_all(&name)
                        .unwrap_or_else(|| panic!("No entry for {name} and raw string {string}"))
                        .values()
                        .collect();
                    assert_eq!(values, value, "Failed for string: {string}");
                }
            }
            Err(e) => {
                let expected = expected.expect_err(&format!("Expected an error for {string}"));
                use ParseError::*;
                match (e, expected) {
                    (EmptyName, EmptyName)
                    | (MissingPair, MissingPair)
                    | (ProcessingError(_), ProcessingError(_)) => {}
                    (actual, expected) => {
                        panic!(
                            "Expected {:?}, but got {:?} for {}",
                            expected, actual, string
                        );
                    }
                }
            }
        }
    }

    #[test]
    fn parse_unencoded() {
        let cases = [
            ("", cookies![]),
            (";;", cookies![]),
            ("name=value", cookies!["name" => "value"]),
            ("a=%20", cookies!["a" => "%20"]),
            ("a=d#$%^&*()_", cookies!["a" => "d#$%^&*()_"]),
            ("  name=value  ", cookies!["name" => "value"]),
            ("name=value  ", cookies!["name" => "value"]),
            (
                "name=value;;other=key",
                cookies!["name" => "value", "other" => "key"],
            ),
            (
                "name=value;  ;other=key",
                cookies!["name" => "value", "other" => "key"],
            ),
            (
                "name=value ;  ;other=key",
                cookies!["name" => "value", "other" => "key"],
            ),
            (
                "name=value ;  ; other=key",
                cookies!["name" => "value", "other" => "key"],
            ),
            (
                "name=value ;  ; other=key ",
                cookies!["name" => "value", "other" => "key"],
            ),
            (
                "name=value ;  ; other=key;; ",
                cookies!["name" => "value", "other" => "key"],
            ),
            (
                ";name=value ;  ; other=key ",
                cookies!["name" => "value", "other" => "key"],
            ),
            (";a=1 ;  ; b=2 ", cookies!["a" => "1", "b" => "2"]),
            (";a=1 ;  ; b= ", cookies!["a" => "1", "b" => ""]),
            (" ;   a=1 ;  ; ;;c===  ", cookies!["a" => "1", "c" => "=="]),
            (";a=1 ;  ; =v ; c=", Err(EmptyName)),
            (" ;   a=1 ;  ; =v ; ;;c=", Err(EmptyName)),
            (" ;   a=1 ;  ; =v ; ;;c===  ", Err(EmptyName)),
            ("yo", Err(MissingPair)),
        ];

        let processor: Processor = Config {
            percent_encode: false,
            crypto_rules: vec![],
            ..Default::default()
        }
        .into();

        for (string, expected) in cases {
            check_case(string, &processor, expected)
        }
    }

    #[test]
    fn parse_encoded() {
        let cases = [
            ("", cookies![]),
            (";;", cookies![]),
            ("name=value", cookies!["name" => "value"]),
            ("a=%20", cookies!["a" => " "]),
            ("a%20or%20b=1", cookies!["a or b" => "1"]),
            ("  name=value  ", cookies!["name" => "value"]),
            ("name=value  ", cookies!["name" => "value"]),
            (
                "name=value;;other=key",
                cookies!["name" => "value", "other" => "key"],
            ),
            (
                "name=value;  ;other=key",
                cookies!["name" => "value", "other" => "key"],
            ),
            (
                "name=value ;  ;other=key",
                cookies!["name" => "value", "other" => "key"],
            ),
            (
                "name=value ;  ; other=key",
                cookies!["name" => "value", "other" => "key"],
            ),
            (
                "name=value ;  ; other=key ",
                cookies!["name" => "value", "other" => "key"],
            ),
            (
                "name=value ;  ; other=key;; ",
                cookies!["name" => "value", "other" => "key"],
            ),
            (
                ";name=value ;  ; other=key ",
                cookies!["name" => "value", "other" => "key"],
            ),
            (";a=1 ;  ; b=2 ", cookies!["a" => "1", "b" => "2"]),
            (";a=1 ;  ; b= ", cookies!["a" => "1", "b" => ""]),
            (" ;   a=1 ;  ; ;;c===  ", cookies!["a" => "1", "c" => "=="]),
            (";a=1 ;  ; =v ; c=", Err(EmptyName)),
            (" ;   a=1 ;  ; =v ; ;;c=", Err(EmptyName)),
            (" ;   a=1 ;  ; =v ; ;;c===  ", Err(EmptyName)),
            ("yo", Err(MissingPair)),
            ("a=d#$%^&*()_", cookies!["a" => "d#$%^&*()_"]),
            (
                "a=%F1%F2%F3%C0%C1%C2",
                Err(ParseError::ProcessingError(ProcessIncomingError::Decoding(
                    DecodingError {
                        raw_value: "d#$%^&*()_".to_string(),
                        source: anyhow::anyhow!("invalid percent encoding"),
                    },
                ))),
            ),
        ];

        let processor: Processor = Config {
            percent_encode: true,
            crypto_rules: vec![],
            ..Default::default()
        }
        .into();

        for (string, expected) in cases {
            check_case(string, &processor, expected)
        }
    }
}