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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
mod types;
mod parsers;
mod headers;

pub use self::types::*;
pub use self::headers::*;

use std::io;
use errors::{ErrorKind as MqttErrorKind, Result as MqttResult};
use errors::proto;
use nom::IResult;
use linked_hash_map::{Entry,LinkedHashMap};
use bytes::{Bytes, BytesMut, BufMut, Writer};
use self::parsers::packet;
use self::headers::*;

fn encode_vle(num: usize) -> Option<Bytes> {
    let mut collect: BytesMut = BytesMut::with_capacity(4);
    let mut val: usize = num;

    if num > 268_435_455 {
        return None;
    }

    loop {
        let mut enc_byte: u8 = (val % 128) as u8;
        val /= 128;
        if val > 0 {
            enc_byte |= 128;
        }
        collect.put_u8(enc_byte);
        if val <= 0 {
            break;
        }
    }
    return Some(collect.freeze());
}

#[derive(Clone, Serialize, Deserialize)]
pub struct Headers {
    data: LinkedHashMap<String, Vec<u8>>,
}

impl Headers {
    pub fn new() -> Headers {
        Headers { data: LinkedHashMap::new() }
    }

    pub fn set<H: Header>(&mut self, value: H) {
        let mut bytes = BytesMut::new();
        let key = H::header_name().into();
        let value = value.fmt_header(&mut bytes);
        let _ = self.data.insert(key, bytes.to_vec());
    }

    pub fn set_raw(&mut self, name: &'static str, value: &[u8]) {
        let _ = self.data.insert(name.into(),Vec::from(value));
    }

    pub fn get<H: Header>(&self) -> Option<H> {
        let key = H::header_name().into();
        self.data.get(key)
                .ok_or(MqttErrorKind::PacketDecodingError.into())
                .and_then(|raw| {
                    let raw : Bytes = Bytes::from(raw.as_slice());
                    H::parse_header(&raw)
                }).ok()
    }

    pub fn encode(&self, out: &mut BytesMut) {
        for header in self.data.values() {
            out.put_slice(header);
        }
    }
}

pub trait Header: Sized {
    fn header_name() -> &'static str;
    fn parse_header(raw: &Bytes) -> MqttResult<Self>;
    fn fmt_header(&self, out: &mut BytesMut) -> MqttResult<()>;
}

#[derive(Clone, Serialize, Deserialize)]
pub struct MqttPacket {
    pub ty: PacketType,
    pub flags: PacketFlags,
    pub headers: Headers,
    pub payload: Payload,
}

impl MqttPacket {
    /// Attempts to decode a MQTT Control Packet from the provided slice of bytes.
    ///
    /// If there is a fully formed packet in the slice, `Ok(Some((MqttPacket, Vec<u8>)))` will be
    /// returned, containing the formed packet and the rest of the slice.
    ///
    /// If there is not enough bytes in the slice to create a fully formed packet, `Ok(None)` will
    /// be returned.
    ///
    /// If an error occurs decoding the bytes, an error will be returned.
    pub fn from_slice<B: AsRef<[u8]>>(data: B) -> MqttResult<Option<(MqttPacket, Vec<u8>)>> {
        let slice = data.as_ref();
        match packet(slice) {
            IResult::Done(rest, (ty, fl, hd, pl)) => Ok(Some((
                MqttPacket {
                    ty: ty,
                    flags: fl,
                    headers: hd,
                    payload: pl,
                },
                rest.into(),
            ))),
            IResult::Incomplete(_) => return Ok(None),
            IResult::Error(e) => bail!(MqttErrorKind::PacketDecodingError),
        }
    }

    pub fn validate(&self) -> MqttResult<()> {
        use self::PacketType::*;
        match self.ty {
            ConnAck | PubAck | PubRec | PubComp | SubAck | UnsubAck | PingResp => {
                if self.flags.bits() == 0 {
                    Ok(())
                } else {
                    bail!(proto::ErrorKind::InvalidPacket(
                        "Invalid packet flags".into(),
                    ))
                }
            }
            PubRel => {
                if self.flags.bits() == 0b0010 {
                    Ok(())
                } else {
                    bail!(proto::ErrorKind::InvalidPacket(
                        "Invalid packet flags".into(),
                    ))
                }
            }
            _ => Ok(()),
        }
    }

    pub fn connect_packet(
        version: ProtoLvl,
        lwt: Option<LWTMessage>,
        creds: Credentials<MqttString>,
        clean: bool,
        keep_alive: u16,
        id: Option<MqttString>,
    ) -> MqttPacket {

        let mut flags = ConnFlags::empty();
        let mut headers = Headers::new();

        let last_will = if let Some(will) = lwt {
            flags.insert(will.encode_flags());
            Some((will.topic, will.message.to_vec()))
        } else {
            None
        };

        if let Some((_, ref pass)) = creds {
            flags.insert(USERNAME);

            if let &Some(_) = pass {
                flags.insert(PASSWORD);
            }
        }

        if clean {
            flags.insert(CLEAN_SESS);
        }

        let payload = Payload::Connect(id.unwrap_or(MqttString::new()), last_will, creds);

        headers.set(ProtocolName::new(MqttString::from_str_lossy("MQTT")));
        headers.set(ProtocolLevel::new(version));
        headers.set(ConnectFlags::new(flags));
        headers.set(KeepAlive::new(keep_alive));

        MqttPacket {
            ty: PacketType::Connect,
            flags: PacketFlags::empty(),
            headers: headers,
            payload: payload,
        }
    }

    pub fn publish_packet(
        flags: PacketFlags,
        topic: MqttString,
        id: u16,
        msg: Bytes,
    ) -> MqttPacket {

        let mut headers = Headers::new();
        headers.set(TopicName::new(topic));

        if flags.contains(QOS1 | QOS2) {
            headers.set(PacketId::new(id));
        }

        MqttPacket {
            ty: PacketType::Publish,
            flags: flags,
            headers: headers,
            payload: Payload::Application(msg.to_vec()),
        }
    }

    pub fn pub_ack_packet(id: u16) -> MqttPacket {
        let mut headers = Headers::new();
        headers.set(PacketId::new(id));
        MqttPacket {
            ty: PacketType::PubAck,
            flags: PacketFlags::empty(),
            headers: headers,
            payload: Payload::None,
        }
    }

    pub fn pub_rec_packet(id: u16) -> MqttPacket {
        let mut headers = Headers::new();
        headers.set(PacketId::new(id));
        MqttPacket {
            ty: PacketType::PubRec,
            flags: PacketFlags::empty(),
            headers: headers,
            payload: Payload::None,
        }
    }

    pub fn pub_rel_packet(id: u16) -> MqttPacket {
        let mut headers = Headers::new();
        headers.set(PacketId::new(id));
        MqttPacket {
            ty: PacketType::PubRel,
            flags: PUBREL,
            headers: headers,
            payload: Payload::None,
        }
    }

    pub fn pub_comp_packet(id: u16) -> MqttPacket {
        let mut headers = Headers::new();
        headers.set(PacketId::new(id));
        MqttPacket {
            ty: PacketType::PubComp,
            flags: PacketFlags::empty(),
            headers: headers,
            payload: Payload::None,
        }
    }

    pub fn subscribe_packet(id: u16, subscriptions: Vec<Subscription>) -> MqttPacket {
        let mut headers = Headers::new();
        headers.set(PacketId::new(id));

        MqttPacket {
            ty: PacketType::Subscribe,
            flags: SUB,
            headers: headers,
            payload: Payload::Subscribe(subscriptions),
        }
    }

    pub fn unsubscribe_packet(id: u16, subscriptions: Vec<Subscription>) -> MqttPacket {
        let mut subs = Vec::new();
        for sub in subscriptions {
            subs.push(sub.topic);
        }

        let mut headers = Headers::new();
        headers.set(PacketId::new(id));

        MqttPacket {
            ty: PacketType::Unsubscribe,
            flags: UNSUB,
            headers: headers,
            payload: Payload::Unsubscribe(subs),
        }
    }

    pub fn ping_req_packet() -> MqttPacket {
        MqttPacket {
            ty: PacketType::PingReq,
            flags: PacketFlags::empty(),
            headers: Headers::new(),
            payload: Payload::None,
        }
    }

    pub fn disconnect_packet() -> MqttPacket {
        MqttPacket {
            ty: PacketType::Disconnect,
            flags: PacketFlags::empty(),
            headers: Headers::new(),
            payload: Payload::None,
        }
    }

    pub fn encode(&self) -> Option<Bytes> {
        let mut buf = BytesMut::with_capacity(4096);
        let ty_flags: u8 = (((self.ty as u32) as u8) << 4) + self.flags.bits();
        buf.put_u8(ty_flags);
        let mut payload_buf = BytesMut::with_capacity(2048);
        self.encode_headers(&mut payload_buf);
        self.payload.encode(&mut payload_buf);
        if let Some(vle_bytes) = encode_vle(payload_buf.len()) {
            buf.put(vle_bytes);
            buf.put(payload_buf);
            Some(buf.freeze())
        } else {
            None
        }
    }

    fn encode_headers(&self, out: &mut BytesMut) {
        self.headers.encode(out);
    }
}