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
#[macro_use]
extern crate server;
extern crate bincode;

use std::net::{Ipv4Addr, AddrParseError, TcpStream};
use std::str::FromStr;
use std::io::{self, Write};
use std::fmt;
pub use server::net::types;
pub use server::logger;
use server::storage::ResultSet;
use bincode::SizeLimit;
use bincode::rustc_serialize::{EncodingError, DecodingError,
    decode_from, encode_into};
use types::*;

const PROTOCOL_VERSION : u8 = 1;

/// Client specific Error definition.
#[derive(Debug)]
pub enum Error {
    AddrParse(AddrParseError),
    Io(io::Error),
    UnexpectedPkg,
    Encode(EncodingError),
    Decode(DecodingError),
    Auth,
    Server(ClientErrMsg),
}

/// Implement display for description of Error
impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        std::error::Error::description(self).fmt(f)
    }
}

/// Implement description for this Error enum
impl std::error::Error for Error {
    fn description(&self) -> &str {
        match self {
            &Error::AddrParse(_) => "wrong IPv4 address format",
            &Error::Io(_) => "IO error occured",
            &Error::UnexpectedPkg => "received unexpected package",
            &Error::Encode(_) => "could not encode/ send package",
            &Error::Decode(_) => "could not decode/ receive package",
            &Error::Auth => "could not authenticate user",
            &Error::Server(ref e) => { &e.msg }
        }
    }
}

/// Implement the conversion from io::Error to Connection-Error
impl From<io::Error> for Error {
    fn from(err: io::Error) -> Error {
        Error::Io(err)
    }
}

/// Implement the conversion from AddrParseError to Connection-Error
impl From<AddrParseError> for Error {
    fn from(err: AddrParseError) -> Error {
        Error::AddrParse(err)
    }
}

/// Implement the conversion from EncodingError to NetworkError
impl  From<EncodingError> for Error {
    fn from(err: EncodingError) -> Error {
        Error::Encode(err)
    }
}

/// Implement the conversion from DecodingError to NetworkError
impl From<DecodingError> for Error {
    fn from(err: DecodingError) -> Error {
        Error::Decode(err)
    }
}

/// Implement the conversion from ClientErrMsg to NetworkError
impl From<ClientErrMsg> for Error {
    fn from(err: ClientErrMsg) -> Error {
        Error::Server(err)
    }
}

/// Stores TCPConnection with a server. Contains IP, Port, Login data and
/// greeting from server.
pub struct Connection {
    ip: String,
    port: u16,
    tcp: TcpStream,
    greeting: Greeting,
    user_data: Login,
}

impl Connection {
    /// Establish connection to specified address and port.
    pub fn connect(addr: String, port: u16, usern: String, passwd: String)
        -> Result<Connection, Error>
    {
        // Parse IPv4 address from String
        let tmp_addr = match std::net::Ipv4Addr::from_str(&addr) {
            Ok(tmp_addr) => tmp_addr,
            Err(e) => return Err(e.into())
        };

        // Establish Tcp connection
        let mut tmp_tcp = match TcpStream::connect((tmp_addr, port)) {
            Ok(tmp_tcp) => tmp_tcp,
            Err(e) => return Err(e.into())
        };

        // Greeting message
        match receive(&mut tmp_tcp, PkgType::Greet) {
            Ok(_) => {},
            Err(e) => return Err(e)
        };
        let greet: Greeting =
            try!(decode_from(&mut tmp_tcp, SizeLimit::Bounded(1024)));

        // Login package
        let log = Login { username: usern, password: passwd };
        match encode_into(&PkgType::Login, &mut tmp_tcp,
            SizeLimit::Bounded(1024))
        {
            Ok(_) => {},
            Err(e) => return Err(e.into())
        }

        // Login data
        match encode_into(&log, &mut tmp_tcp, SizeLimit::Bounded(1024)) {
            Ok(_) => {},
            Err(e) => return Err(e.into())
        }

        // Get Login response - either user is authorized or unauthorized
        let status: PkgType =
            try!(decode_from(&mut tmp_tcp, SizeLimit::Bounded(1024)));
        match status {
            PkgType::AccGranted =>
                Ok(Connection { ip: addr, port: port, tcp: tmp_tcp,
                    greeting: greet, user_data: log} ),
            PkgType::AccDenied =>
                Err(Error::Auth),
            _ => Err(Error::UnexpectedPkg)
        }
    }

    /// Send ping-command to server and receive Ok-package
    pub fn ping(&mut self) -> Result<(), Error> {
        match send_cmd(&mut self.tcp, Command::Ping, 1024) {
            Ok(_) => {},
            Err(e) => return Err(e)
        };
        match receive(&mut self.tcp, PkgType::Ok) {
            Ok(_) => Ok(()),
            Err(err) => Err(err)
        }
    }

    /// Send quit-command to server and receive Ok-package
    pub fn quit(&mut self) -> Result<(), Error> {
        match send_cmd(&mut self.tcp, Command::Quit, 1024) {
            Ok(_) => {},
            Err(e) => return Err(e)
        };
        match receive(&mut self.tcp, PkgType::Ok) {
            Ok(_) => Ok(()),
            Err(err) => Err(err)
        }
    }

    // TODO: Return results (response-package)
    pub fn execute(&mut self, query: String) -> Result<DataSet, Error> {
        match send_cmd(&mut self.tcp, Command::Query(query), 1024) {
            Ok(_) => {},
            Err(e) => return Err(e)
        };
        match receive(&mut self.tcp, PkgType::Response) {
            Ok(_) => {
                let rows: ResultSet =
                    try!(decode_from(&mut self.tcp, SizeLimit::Infinite));
                let dataset = preprocess (&rows);
                Ok(dataset)
            },
            Err(err) => Err(err)
        }
    }

    /// Return server version number.
    pub fn get_version(&self) -> u8 {
        self.greeting.protocol_version
    }

    /// Return server greeting message.
    pub fn get_message(&self) -> &str {
        &self.greeting.message
    }

    /// Return ip address for current connection.
    pub fn get_ip(&self) -> &str {
        &self.ip
    }

    /// Return port for current connection.
    pub fn get_port(&self) -> u16 {
        self.port
    }

    /// Return username used for current connection authentication.
    pub fn get_username(&self) -> &str {
        &self.user_data.username
    }
}

/// Return current library version.
#[allow(dead_code)]
fn get_lib_version() -> u8 {
    PROTOCOL_VERSION
}

/// Send command package with actual command, e.g. quit, ping, query.
fn send_cmd<W: Write>(mut s: &mut W, cmd: Command, size: u64)
    -> Result<(), Error>
{
    try!(encode_into(&PkgType::Command, s, SizeLimit::Bounded(1024)));
    try!(encode_into(&cmd, &mut s, SizeLimit::Bounded(size)));
    Ok(())
}

/// Match received packages to expected packages.
fn receive(s: &mut TcpStream, cmd: PkgType) -> Result<(), Error> {
    let status: PkgType = try!(decode_from(s, SizeLimit::Bounded(1024)));

    if status == PkgType::Error {
        let err : ClientErrMsg = try!(decode_from(s, SizeLimit::Infinite));
        return Err(Error::Server(err))
    }

    if status != cmd {
        match status {
            PkgType::Ok => {},
            PkgType::Response => {
                let _ : ResultSet = try!(decode_from(s, SizeLimit::Infinite));
            },
            PkgType::Greet => {
                let _ : Greeting = try!(decode_from(s, SizeLimit::Infinite));
            },
            _ => {}
        }
        return Err(Error::UnexpectedPkg)
    }
    Ok(())
}