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
/*!
Our protocol for message size is similar to WebSockets, but not exactly the same.

If the first byte is 0-253, this is the length of the message content.

If the first byte is 254, read the next 2 bytes, this 16 bit number is the length.

If the first byte is 255, read the next 8 bytes, this 64 bit number is the length.
*/
#![crate_name = "message_protocol"]
#![deny(missing_docs)]
use byteorder::{ByteOrder, LittleEndian};
use std::io::{self};

pub fn encode_message(bytes: &[u8]) -> Vec<u8> {
    //! Encodes a binary message so it can be read on the other side.
    let len = bytes.len();
    if len <= 253 {
        let mut msg = vec![0u8; len + 1];
        msg[0] = len as u8;
        msg[1..].clone_from_slice(bytes);
        msg
    } else if len <= 65535 {
        // next 2 bytes are length
        let mut msg = vec![0u8; len + 3];
        msg[0] = 254;
        LittleEndian::write_u16(&mut msg[1..3], len as u16);
        msg[3..].clone_from_slice(bytes);
        msg
    } else {
        // next 8 bytes are length
        let mut msg = vec![0u8; len + 9];
        msg[0] = 255;
        LittleEndian::write_u64(&mut msg[1..9], len as u64);
        msg[9..].clone_from_slice(bytes);
        msg
    }
}

pub fn decode_message<T: Iterator<Item = Result<u8, io::Error>>>(
    mut iter: &mut T,
) -> io::Result<Vec<u8>> {
    //! Decodes a binary message, which was encoded on the other side. May return an error if the
    //! data is invalid.

    fn copy_or_result<T: Iterator<Item = Result<u8, io::Error>>>(
        mut iter: T,
        target: &mut [u8],
        amount: usize,
    ) -> (T, io::Result<()>) {
        for i in 0..amount {
            if let Err(x) = match iter.next() {
                Some(num_or_err) => match num_or_err {
                    Ok(num) => {
                        target[i] = num;
                        Ok(())
                    }
                    Err(x) => Err(x),
                },
                None => Err(io::Error::new(
                    io::ErrorKind::Interrupted,
                    "stopped in the middle of a message",
                )),
            } {
                return (iter, Err(x));
            }
        }
        (iter, Ok(()))
    }

    struct TakeNoMoveIterator<'a> {
        remaining: usize,
        iter: &'a mut dyn Iterator<Item = Result<u8, io::Error>>,
    }

    impl Iterator for TakeNoMoveIterator<'_> {
        type Item = Result<u8, io::Error>;

        fn next(&mut self) -> Option<Self::Item> {
            if self.remaining == 0 {
                None
            } else {
                self.remaining -= 1;
                self.iter.next()
            }
        }
    }

    let first_byte_option = iter.next();
    if let Some(first_byte) = first_byte_option {
        let message_length = match first_byte {
            Ok(255) => {
                // read next 8 bytes for length
                let mut buf = [0u8; 8];
                let (_, err) = copy_or_result(
                    TakeNoMoveIterator {
                        remaining: 8,
                        iter: &mut iter,
                    },
                    &mut buf,
                    8,
                );
                if let Err(x) = err {
                    return Err(x);
                }
                LittleEndian::read_u64(&buf) as usize
            }
            Ok(254) => {
                // read next 2 bytes for length
                let mut buf = [0u8; 2];
                let (_, err) = copy_or_result(
                    TakeNoMoveIterator {
                        remaining: 2,
                        iter: &mut iter,
                    },
                    &mut buf,
                    2,
                );
                if let Err(x) = err {
                    return Err(x);
                }
                LittleEndian::read_u16(&buf) as usize
            }
            Ok(x) => {
                // read next x bytes, this is the message
                x as usize
            }
            Err(_) => {
                return Err(io::Error::new(
                    io::ErrorKind::Interrupted,
                    "can't read first byte of message",
                ))
            }
        };
        let mut buf = vec![0u8; message_length];
        let (_, err) = copy_or_result(
            TakeNoMoveIterator {
                remaining: message_length,
                iter: &mut iter,
            },
            &mut buf,
            message_length,
        );
        if let Err(x) = err {
            return Err(x);
        }
        Ok(buf)
    } else {
        return Err(io::Error::new(
            io::ErrorKind::Interrupted,
            "can't read first byte of message",
        ));
    }
}

use std::io::{Read, Write};
use std::net::{SocketAddr, TcpListener, TcpStream, ToSocketAddrs};
use std::sync::mpsc;
use std::thread;

/// All events that can come from a client/server.
pub enum Message {
    /// Opened client/server
    Open,
    /// Recieved bytes
    Bytes(Vec<u8>),
    /// Closed client/server
    Close,
}

/// A message recieved from a client
pub struct ClientMessage {
    /// The message
    pub message: Message,
    /// The address of the client.
    pub address: SocketAddr,
    write_tx: mpsc::Sender<Result<Vec<u8>, ()>>,
}

impl ClientMessage {
    /// Write a message to the client
    pub fn write(&self, what: Vec<u8>) {
        self.write_tx.send(Ok(what));
    }
}

/// Listens for TCP on given address asynchronously.
///
/// Returns a Reciever which sends messages of the type Message
///
/// Example:
/// ```
/// let recieve_messages = message_protocol::listen_to_tcp("127.0.0.1:45932")?;
/// while let Ok(msg) = recieve_messages.recv() {
///     println!("from {}", msg.address);
///     match msg.message {
///         message_protocol::Message::Open => println!("open"),
///         message_protocol::Message::Bytes(b) => println!("bytes {:?}", b),
///         message_protocol::Message::Close => println!("close"),
///      };
///  }
/// ```
pub fn listen_to_tcp<T: ToSocketAddrs>(
    bind_to_address: T,
) -> Result<mpsc::Receiver<ClientMessage>, io::Error> {
    let listener = TcpListener::bind(bind_to_address)?;
    let (tx, rx) = mpsc::channel();
    thread::spawn(move || {
        // listen for individuals connecting to us
        while let Ok((socket, addr)) = listener.accept() {
            // listen for messages from this individual
            // make a writer handle to the socket
            let mut socket_2 = socket.try_clone().unwrap();
            let (write_tx, write_rx) = mpsc::channel::<Result<Vec<u8>, ()>>();
            let write_thread = thread::spawn(move || {
                'outer: while let Ok(msg_or_stop) = write_rx.recv() {
                    if let Ok(msg) = msg_or_stop {
                        socket_2.write_all(&msg);
                    } else {
                        break 'outer;
                    }
                }
            });
            // reading messages
            let mut iter = socket.bytes();
            let tx = tx.clone();
            tx.send(ClientMessage {
                message: Message::Open,
                address: addr,
                write_tx: write_tx.clone(),
            });
            let write_tx2 = write_tx.clone();
            thread::spawn(move || {
                // listen for messages
                while let Ok(message) = decode_message(&mut iter) {
                    tx.send(ClientMessage {
                        message: Message::Bytes(message),
                        address: addr,
                        write_tx: write_tx2.clone(),
                    });
                }
                tx.send(ClientMessage {
                    message: Message::Close,
                    address: addr,
                    write_tx: write_tx2.clone(),
                });
            });
            write_tx.send(Err(())).unwrap();
            write_thread.join().unwrap();
        }
    });
    Ok(rx)
}

/// Use this to write messages back to the server.
pub struct WriteFunction {
    socket: TcpStream,
}

impl WriteFunction {
    /// The method in WriteFunction that actually sends a message.
    pub fn call(&mut self, what: &[u8]) -> Result<(), io::Error> {
        self.socket.write_all(&encode_message(what))
    }
}

/// Connect to TCP on a given address.
///
/// Example:
/// ```
/// let (rx, mut write) = message_protocol::connect_to_tcp("127.0.0.1:45932")?;
/// write.call(b"hi server").unwrap();
/// while let Ok(msg) = rx.recv() {
///     println!("client recieved");
///     match msg {
///         message_protocol::Message::Open => println!("open"),
///         message_protocol::Message::Bytes(b) => println!("bytes {:?}", b),
///         message_protocol::Message::Close => println!("close"),
///     };
///  }
/// ```
pub fn connect_to_tcp<T: ToSocketAddrs>(
    connect_to_address: T,
) -> Result<(mpsc::Receiver<Message>, WriteFunction), io::Error> {
    let socket = TcpStream::connect(connect_to_address)?;
    let (tx, rx) = mpsc::channel();
    tx.send(Message::Open);
    let mut iter = socket.try_clone().unwrap().bytes();
    thread::spawn(move || {
        // listen for messages
        while let Ok(message) = decode_message(&mut iter) {
            tx.send(Message::Bytes(message));
        }
        tx.send(Message::Close);
    });
    Ok((rx, WriteFunction { socket }))
}