racoon 0.1.9

Racoon is a fast, fully customizable web framework for Rust focusing on simplicity.
Documentation 
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

use std::collections::HashMap;
use std::sync::Arc;

use crate::core::forms::{FormConstraints, FormData, FormFieldError};
use crate::core::headers::{HeaderValue, Headers};
use crate::core::parser::params::parse_url_encoded;

use crate::core::stream::Stream;

pub type FormFields = HashMap<String, Vec<String>>;

pub struct UrlEncodedParser {
    stream: Arc<Stream>,
    form_constraints: Arc<FormConstraints>,
    content_length: usize,
}

impl UrlEncodedParser {
    pub fn from(
        stream: Arc<Stream>,
        headers: &Headers,
        form_constraints: Arc<FormConstraints>,
    ) -> Result<UrlEncodedParser, FormFieldError> {
        let content_length;
        if let Some(value) = headers.value("Content-Length") {
            content_length = match value.parse::<usize>() {
                Ok(value) => value,
                Err(_) => {
                    return Err(FormFieldError::Others(
                        None,
                        "Invalid content length header.".to_owned(),
                        false
                    ));
                }
            }
        } else {
            return Err(FormFieldError::Others(
                None,
                "Content-Length header is missing.".to_owned(),
                false
            ));
        }

        Ok(UrlEncodedParser {
            stream,
            form_constraints,
            content_length,
        })
    }

    ///
    /// Reads body from the stream equal to the `Content-Length` specified in the header, decodes
    /// url encoded raw body and returns the result.
    ///
    async fn read_query_params_from_stream(&self) -> Result<FormFields, FormFieldError> {
        let max_body_size = self
            .form_constraints
            .max_body_size(self.stream.buffer_size().await);

        if self.content_length > max_body_size {
            return Err(FormFieldError::MaxBodySizeExceed);
        }

        let mut buffer = vec![];

        loop {
            if buffer.len() >= self.content_length {
                let value = String::from_utf8_lossy(&buffer);
                return Ok(parse_url_encoded(value.to_string().as_str()));
            }

            let chunk = match self.stream.read_chunk().await {
                Ok(bytes) => bytes,
                Err(error) => {
                    return Err(FormFieldError::Others(None, error.to_string(), true));
                }
            };
            buffer.extend(chunk);
        }
    }

    ///
    /// Returns parsing result for url encoded request body considering form constraints.
    ///
    pub async fn parse(
        stream: Arc<Stream>,
        headers: &Headers,
        form_constraints: Arc<FormConstraints>,
    ) -> Result<FormData, FormFieldError> {
        let parser = UrlEncodedParser::from(stream, headers, form_constraints)?;
        let params = parser.read_query_params_from_stream().await?;
        Ok(params)
    }
}

#[cfg(test)]
pub mod test {
    use std::collections::HashMap;
    use std::sync::Arc;

    use crate::core::forms::{FormConstraints, FormFieldError};
    use crate::core::headers::{HeaderValue, Headers};
    use crate::core::shortcuts::SingleText;
    use crate::core::stream::{AbstractStream, TestStreamWrapper};

    use super::UrlEncodedParser;

    #[tokio::test()]
    async fn test_url_encode_parser() {
        let mut headers = Headers::new();
        let test_data = b"name=John&location=ktm".to_vec();
        headers.set("Content-Length", test_data.len().to_string());

        let stream: Box<dyn AbstractStream> = Box::new(TestStreamWrapper::new(test_data, 1024));

        let form_constraints = Arc::new(FormConstraints::new(
            2 * 1024 * 1024,
            2 * 1024 * 1024,
            500 * 1024 * 1024,
            2 * 1024 * 1024,
            HashMap::new(),
        ));

        let url_encode_parser =
            UrlEncodedParser::parse(Arc::new(stream), &headers, form_constraints).await;
        assert_eq!(true, url_encode_parser.is_ok());

        let parse_result = url_encode_parser.unwrap();
        assert_eq!(Some(&"John".to_string()), parse_result.value("name"));
        assert_eq!(Some(&"ktm".to_string()), parse_result.value("location"));
    }

    #[tokio::test()]
    async fn test_no_content_length_parsing() {
        let headers = Headers::new();
        let test_data = b"name=John&location=ktm".to_vec();

        let stream: Box<dyn AbstractStream> = Box::new(TestStreamWrapper::new(test_data, 1024));

        let form_constraints = Arc::new(FormConstraints::new(
            2 * 1024 * 1024,
            2 * 1024 * 1024,
            500 * 1024 * 1024,
            2 * 1024 * 1024,
            HashMap::new(),
        ));

        let url_encode_parser =
            UrlEncodedParser::parse(Arc::new(stream), &headers, form_constraints).await;
        assert_eq!(true, url_encode_parser.is_err());

        let form_field_error = url_encode_parser.unwrap_err();
        match form_field_error {
            FormFieldError::Others(_, _, _) => {
            }
            _ => {
                assert!(true)
            }
        }
    }
}