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
use byteorder::LittleEndian;
use bytes;
use bytes::ByteOrder;
use std::cmp::min;
use std::error::Error;

use crate::traits::Exception;

const HEADER_ROUTE_LENGTH: usize = 4;
const HEADER_POSTFIX_LENGTH: usize = 4;
//Main Net
const HEADER_PREFIX: [u8; 4] = [172, 215, 103, 237];
//Test Net
// const HEADER_PREFIX: [u8; 4] = [137, 136, 143, 254];
const MAX_PACKET_SIZE: usize = 1024 * 1024;

#[derive(PartialEq, PartialOrd, Debug, Clone)]
enum ParseState {
    HeaderPrefix,
    HeaderRoute,
    HeaderBodyLength,
    Body,
}
#[derive(Clone)]
pub struct SocketParser {
    buffer: Vec<u8>,
    state: ParseState,
    parse_index: usize,
    scrap_buffer: Vec<u8>,
    route: u32,
    body_length: u32,
    route_buffer: Vec<u8>,
    length_buffer: Vec<u8>,
    messages: Vec<(Vec<u8>, u32)>,
}

impl SocketParser {
    pub fn new() -> Self {
        Self {
            buffer: Vec::new(),
            state: ParseState::HeaderPrefix,
            parse_index: 0,
            scrap_buffer: Vec::with_capacity(4),
            route: 0,
            body_length: 0,
            route_buffer: vec![0; HEADER_ROUTE_LENGTH],
            length_buffer: vec![0; HEADER_POSTFIX_LENGTH],
            messages: Vec::new(),
        }
    }

    fn reset_parser(&mut self) {
        self.buffer.clear();
        self.state = ParseState::HeaderPrefix;
        self.parse_index = 0;
        self.scrap_buffer.clear();
        self.route = 0;
        self.body_length = 0;
    }

    pub fn parse(
        &mut self,
        bytes: &Vec<u8>,
    ) -> Result<(Option<Vec<(Vec<u8>, u32)>>, usize), Box<Error>> {
        let mut new_data_index = 0;
        while new_data_index < bytes.len() {
            match self.state {
                ParseState::HeaderPrefix => {
                    self.parse_header_prefix(bytes, &mut new_data_index)?;
                }
                ParseState::HeaderRoute => {
                    self.parse_header_route(bytes, &mut new_data_index)?;
                }
                ParseState::HeaderBodyLength => {
                    self.parse_body_length(bytes, &mut new_data_index)?;
                }
                ParseState::Body => {
                    self.parse_body(bytes, &mut new_data_index)?;
                }
            }
        }
        let mut opt = (None, new_data_index);
        if self.messages.len() > 0 {
            opt = (Some(self.messages.clone()), new_data_index);
            self.messages.clear();
        }
        Ok(opt)
    }
    fn parse_header_prefix(
        &mut self,
        new_data: &Vec<u8>,
        new_data_index: &mut usize,
    ) -> Result<(), Box<Error>> {
        while new_data_index < &mut new_data.len() && self.parse_index < HEADER_PREFIX.len() {
            if new_data[*new_data_index] != HEADER_PREFIX[self.parse_index] {
                return Err(Box::new(Exception::new("Header Prefix Mismatch")));
            } else {
                self.parse_index += 1;
                *new_data_index += 1;
            }
        }
        if self.parse_index == HEADER_PREFIX.len() {
            self.state = ParseState::HeaderRoute;
            self.parse_index = 0;
        }
        Ok(())
    }

    fn parse_header_route(
        &mut self,
        new_data: &Vec<u8>,
        new_data_index: &mut usize,
    ) -> Result<(), Box<Error>> {
        if let Some(route) = self.parse_uint_32_le(new_data_index, new_data) {
            self.state = ParseState::HeaderBodyLength;
            self.route = route;
            self.parse_index = 0;
        }
        Ok(())
    }

    fn parse_body_length(
        &mut self,
        new_data: &Vec<u8>,
        new_data_index: &mut usize,
    ) -> Result<(), Box<Error>> {
        if let Some(length) = self.parse_uint_32_le(new_data_index, new_data) {
            if length as usize > MAX_PACKET_SIZE {
                return Err(Box::new(Exception::new("Packet size exceeded")));
            }
            self.state = ParseState::Body;
            self.buffer = Vec::with_capacity(length as usize);
            self.body_length = length;
            self.parse_index = 0;
        }
        Ok(())
    }

    fn parse_body(
        &mut self,
        new_data: &Vec<u8>,
        new_data_index: &mut usize,
    ) -> Result<(), Box<Error>> {
        while new_data_index < &mut new_data.len() {
            self.buffer.push(new_data[*new_data_index]);
            *new_data_index += 1;
            self.parse_index += 1;
            if self.parse_index == self.body_length as usize {
                self.messages.push((self.buffer.clone(), self.route));
                self.reset_parser();
                break;
            }
        }
        Ok(())
    }

    fn parse_uint_32_le(&mut self, next_index: &mut usize, new_data: &Vec<u8>) -> Option<u32> {
        let new_bytes_available = new_data.len() - *next_index;
        if self.parse_index == 0 && new_bytes_available >= 4 {
            let num = LittleEndian::read_u32(&new_data[*next_index..*next_index + 4]);
            *next_index += 4;
            return Some(num);
        } else {
            let source_end = *next_index + min(new_bytes_available, 4 - self.parse_index);
            let bytes_copied = self.copy_bytes(&new_data[*next_index..source_end]);
            *next_index += bytes_copied;
            self.parse_index += bytes_copied;
            if self.parse_index == 4 {
                return Some(LittleEndian::read_u32(&self.scrap_buffer[0..4]));
            }
        }
        None
    }

    fn copy_bytes(&mut self, bytes_to_copy: &[u8]) -> usize {
        let mut bytes_copied = 0;
        for i in 0..bytes_to_copy.len() {
            self.scrap_buffer[self.parse_index] = bytes_to_copy[i];
            bytes_copied = i;
        }
        bytes_copied
    }

    pub fn prepare_packet(&mut self, route: u32, buf: &[u8]) -> Result<Vec<u8>, Box<Error>> {
        if buf.len() > MAX_PACKET_SIZE {
            return Err(Box::new(Exception::new("Max packet size exceeded")));
        }
        LittleEndian::write_u32(&mut self.route_buffer, route);
        LittleEndian::write_u32(&mut self.length_buffer, buf.len() as u32);
        let mut bytes = Vec::with_capacity(buf.len() + 12);
        bytes.extend_from_slice(&HEADER_PREFIX);
        bytes.extend_from_slice(&self.route_buffer);
        bytes.extend_from_slice(&self.length_buffer);
        bytes.extend_from_slice(buf);
        Ok(bytes)
    }
    /// Prepares a packet to send to the defined route without requiring an instance of the socket parser struct
    pub fn prepare_packet_default(route: u32, buf: &[u8]) -> Result<Vec<u8>, Box<Error>> {
        if buf.len() > MAX_PACKET_SIZE {
            return Err(Box::new(Exception::new("Max packet size exceeded")));
        }
        let mut route_buffer = vec![0; HEADER_ROUTE_LENGTH];
        let mut length_buffer = vec![0; HEADER_POSTFIX_LENGTH];
        LittleEndian::write_u32(&mut route_buffer, route);
        LittleEndian::write_u32(&mut length_buffer, buf.len() as u32);
        let mut bytes = Vec::with_capacity(buf.len() + 12);
        bytes.extend_from_slice(&HEADER_PREFIX);
        bytes.extend_from_slice(&route_buffer);
        bytes.extend_from_slice(&length_buffer);
        bytes.extend_from_slice(buf);
        Ok(bytes)
    }
}

#[cfg(test)]
pub mod tests {
    use super::*;
    use bytes::BytesMut;
    #[test]
    fn it_should_parse_two_separate_packets() {
        let mut parser = SocketParser::new();
        let bytes1 = vec![172, 215, 103, 237, 0, 0, 0, 64, 60, 0, 0, 0, 10];
        let bytes2 = vec![
            58, 8, 13, 18, 5, 104, 121, 99, 111, 110, 40, 212, 63, 50, 44, 74, 65, 119, 115, 117,
            85, 69, 104, 116, 117, 53, 120, 65, 110, 87, 122, 72, 122, 75, 76, 67, 55, 78, 72, 86,
            86, 85, 87, 97, 57, 70, 83, 77, 69, 54, 69, 88, 97, 104, 97, 103, 113, 52, 122,
        ];
        let expected_out = vec![
            10, 58, 8, 13, 18, 5, 104, 121, 99, 111, 110, 40, 212, 63, 50, 44, 74, 65, 119, 115,
            117, 85, 69, 104, 116, 117, 53, 120, 65, 110, 87, 122, 72, 122, 75, 76, 67, 55, 78, 72,
            86, 86, 85, 87, 97, 57, 70, 83, 77, 69, 54, 69, 88, 97, 104, 97, 103, 113, 52, 122,
        ];
        let _ = parser.parse(&bytes1);
        assert_eq!(parser.state, ParseState::Body);
        let (parsed, _bytes) = parser.parse(&bytes2).unwrap();
        match parsed {
            Some(vec) => {
                let (buf, _route) = &vec[0];
                assert_eq!(vec.len(), 1);
                assert_eq!(buf, &expected_out);
            }
            None => {
                assert!(1 < 0);
            }
        }
    }

    #[test]
    fn it_should_return_an_error_from_a_mismatched_header_prefix() {
        let mut parser = SocketParser::new();
        let bytes1 = vec![172, 216, 103, 237, 0, 0, 0, 64, 60, 0, 0, 0, 10];
        let res = parser.parse(&bytes1);
        match res {
            Ok(_) => assert_eq!(1, 2),
            Err(_e) => assert_eq!(1, 1),
        }
    }
    #[test]
    fn it_should_parse_messages_stuck_together() {
        let mut parser = SocketParser::new();
        let bytes = BytesMut::from(vec![
            137, 136, 143, 254, 1, 0, 0, 64, 5, 0, 0, 0, 154, 1, 2, 16, 100, 137, 136, 143, 254, 2,
            0, 0, 64, 5, 0, 0, 0, 170, 1, 2, 16, 0,
        ]);
        let res = parser.parse(&bytes.to_vec());
        match res {
            Ok(result) => {
                let (opt, parsed) = result;
                assert_eq!(parsed, 34);
                match opt {
                    Some(vec) => {
                        assert_eq!(vec.len(), 2);
                    }
                    None => {}
                }
            }
            Err(_e) => {}
        }
    }
}