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
use clap::Subcommand;
use crc16::{State, ARC};
use serde::{Deserialize, Serialize};
use std::io::Read;
use std::net::TcpStream;

use crate::engine::KvsEngine;
use crate::error::{KVSError, Result};

const CMD_HEAD: &[u8] = &[27, 59];
const LEN_SIZE: usize = 4;
/// Type of integer length of key, value (for DBCommands)
/// or output, message (for ServerResponse)
pub type CommandLenType = u32;

fn check_head(head: &[u8]) -> Result<()> {
    if CMD_HEAD[0] != head[0] || CMD_HEAD[1] != head[1] {
        log::error!("Head not matched: {:?}, received {:?}", CMD_HEAD, head);
        return Err(KVSError::GeneralKVSError);
    }
    Ok(())
}
/// Enumeration to define a commands to KVS engine
#[derive(Debug, Serialize, Deserialize, Subcommand)]
pub enum DBCommands {
    /// Set up value by key into KVS
    Set { key: String, value: String },
    /// Get value by key
    Get { key: String },
    /// Removes value by key
    Rm { key: String },
}

const GET_BYTE: u8 = 1;
const SET_BYTE: u8 = 2;
const RM_BYTE: u8 = 3;

impl DBCommands {
    /// Invoke command on KvsEngine and return ServerResponse
    pub fn invoke_cmd<S: KvsEngine>(&self, store: &mut S) -> ServerResponse {
        match self {
            DBCommands::Get { key } => {
                if let Ok(res) = store.get(key.to_owned()) {
                    match res {
                        Some(value) => ServerResponse::Success { output: value },
                        None => ServerResponse::Success {
                            output: String::from("Key not found"),
                        },
                        // None => ServerResponse::Failure{ message: String::from("Key not found")},
                    }
                } else {
                    ServerResponse::Failure {
                        message: String::from("Internal error"),
                    }
                }
            }
            DBCommands::Set { key, value } => {
                if let Ok(_res) = store.set(key.to_owned(), value.to_owned()) {
                    ServerResponse::Success {
                        output: String::from(""),
                    }
                } else {
                    ServerResponse::Failure {
                        message: String::from("Cant set"),
                    }
                }
            }
            DBCommands::Rm { key } => {
                if let Ok(_res) = store.remove(key.to_owned()) {
                    ServerResponse::Success {
                        output: String::new(),
                    }
                } else {
                    ServerResponse::Failure {
                        message: String::from("Key not found"),
                    }
                }
            }
        }
    }
    /// Pack DBCommands to bytes follow the protocol (consuming self)
    /// with HEAD and CRC-ARC hashsum
    pub fn to_packet(self) -> Result<Vec<u8>> {
        let (cmd, key, value) = match self {
            DBCommands::Get { key } => (GET_BYTE, key, String::from("")),
            DBCommands::Rm { key } => (RM_BYTE, key, String::from("")),
            DBCommands::Set { key, value } => (SET_BYTE, key, value),
        };
        let k_len = key.len() as CommandLenType;
        let v_len = value.len() as CommandLenType;

        let k_len_enc = k_len.to_be_bytes().to_vec();
        let v_len_enc = v_len.to_be_bytes().to_vec();
        let cmd_vec = vec![cmd];
        let packet = [
            CMD_HEAD.to_vec(),
            cmd_vec,
            k_len_enc,
            v_len_enc,
            key.into_bytes(),
            value.into_bytes(),
        ]
        .concat();
        let checksum = State::<ARC>::calculate(&packet).to_be_bytes();
        let packet = [packet, checksum.to_vec()].concat();
        Ok(packet)
    }
    /// Unpack DBCommands from incomming stream by protocol
    /// Check HEAD and CRC-ARC of packet
    pub fn from_stream(stream: &mut TcpStream) -> Result<Self> {
        let mut head = [0u8; 2];
        let _ = &stream.read_exact(&mut head)?;

        check_head(&head)?;

        let mut cmd_array = [0u8; 1];
        let _ = &stream.read_exact(&mut cmd_array)?;
        let cmd = cmd_array[0];

        let mut key_len_coded = [0u8; LEN_SIZE];
        stream.read_exact(&mut key_len_coded)?;
        let mut val_len_coded = [0u8; LEN_SIZE];
        stream.read_exact(&mut val_len_coded)?;
        let key_len = CommandLenType::from_be_bytes(key_len_coded);
        let val_len = CommandLenType::from_be_bytes(val_len_coded);

        let mut key_buff = vec![0u8; key_len as usize];
        stream.read_exact(&mut key_buff)?;
        let key = String::from_utf8_lossy(&key_buff).into_owned();
        let mut value_buff = vec![0u8; val_len as usize];
        stream.read_exact(&mut value_buff)?;
        let value = String::from_utf8_lossy(&value_buff).into_owned();

        // check hashsum of the data
        let mut checksum = vec![0u8; 2];
        stream.read_exact(&mut checksum)?;
        let packet = [
            CMD_HEAD.to_vec(),
            cmd_array.to_vec(),
            key_len_coded.to_vec(),
            val_len_coded.to_vec(),
            key_buff,
            value_buff,
        ]
        .concat();
        let calculated = State::<ARC>::calculate(&packet).to_be_bytes();
        if calculated[0] != checksum[0] && calculated[1] != checksum[1] {
            log::error!(
                "Checksum of command not matched, must be {:?}, received {:?}",
                calculated,
                checksum
            );
            return Err(KVSError::GeneralKVSError);
        }

        match cmd {
            GET_BYTE => Ok(DBCommands::Get { key }),
            SET_BYTE => Ok(DBCommands::Set { key, value }),
            RM_BYTE => Ok(DBCommands::Rm { key }),
            _ => Err(KVSError::GeneralKVSError),
        }
    }
}

const SUCCESS_BYTE: u8 = 100;
const FAILURE_BYTE: u8 = 101;

/// Type to mark success or failure of command invokation
#[derive(Debug)]
pub enum ServerResponse {
    Success { output: String },
    Failure { message: String },
}

impl ServerResponse {
    /// Pack ServerResponse into bytes by protocol (consuming self)
    /// with HEAD and CRC-ARC hashsum
    pub fn to_packet(self) -> Result<Vec<u8>> {
        let (resp_byte, msg) = match self {
            ServerResponse::Success { output } => (SUCCESS_BYTE, output),
            ServerResponse::Failure { message } => (FAILURE_BYTE, message),
        };
        let msg_len = msg.len() as CommandLenType;

        let msg_len_enc = msg_len.to_be_bytes().to_vec();
        let resp_vec = vec![resp_byte];
        let packet = [CMD_HEAD.to_vec(), resp_vec, msg_len_enc, msg.into_bytes()].concat();
        let checksum = State::<ARC>::calculate(&packet).to_be_bytes();
        let packet = [packet, checksum.to_vec()].concat();
        Ok(packet)
    }
    /// Unpack ServerResponse from stream of bytes
    /// Check HEAD and CRC-ARC of packet
    pub fn from_stream(stream: &mut TcpStream) -> Result<Self> {
        let mut head = [0u8; 2];
        let _ = &stream.read_exact(&mut head)?;

        check_head(&head)?;

        let mut resp_byte = [0u8; 1];
        let _ = &stream.read_exact(&mut resp_byte)?;

        let resp_type = resp_byte[0];

        let mut msg_len_coded = [0u8; LEN_SIZE];
        stream.read_exact(&mut msg_len_coded)?;

        let msg_len = CommandLenType::from_be_bytes(msg_len_coded);

        let mut msg_vec = vec![0u8; msg_len as usize];
        stream.read_exact(&mut msg_vec)?;
        let msg = String::from_utf8_lossy(&msg_vec).into_owned();

        // check hashsum of the data
        let mut checksum = vec![0u8; 2];
        stream.read_exact(&mut checksum)?;
        let packet = [
            CMD_HEAD.to_vec(),
            resp_byte.to_vec(),
            msg_len_coded.to_vec(),
            msg_vec,
        ]
        .concat();
        let calculated = State::<ARC>::calculate(&packet).to_be_bytes();
        if calculated[0] != checksum[0] && calculated[1] != checksum[1] {
            log::error!(
                "Response checksum is not matched, must be {:?}, received {:?}",
                calculated,
                checksum
            );
            return Err(KVSError::GeneralKVSError);
        }

        match resp_type {
            SUCCESS_BYTE => Ok(ServerResponse::Success { output: msg }),
            FAILURE_BYTE => Ok(ServerResponse::Failure { message: msg }),
            _ => Err(KVSError::GeneralKVSError),
        }
    }
}