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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
// Copyright (c) 2021 Open Community Project Association https://ocpa.ch
// This software is published under the AGPLv3 license.

//! # Qaul Messaging Service
//!
//! The messaging service is used for sending, receiving and
//! relay chat messages.

use libp2p::PeerId;
use prost::Message;
use serde::{Deserialize, Serialize};
use sled_extensions::{bincode::Tree, DbExt};
use state::Storage;
use std::collections::VecDeque;
use std::sync::RwLock;

#[cfg(emulate)]
mod network_emul;

pub mod process;
pub mod retransmit;

use super::chat::{ChatFile, ChatStorage};
use super::crypto::Crypto;
use crate::connections::ConnectionModule;
use crate::node::user_accounts::{UserAccount, UserAccounts};
use crate::router::table::RoutingTable;
use crate::storage::database::DataBase;
use crate::utilities::timestamp::Timestamp;
use process::MessagingProcess;
use qaul_messaging::QaulMessagingReceived;

/// Import protobuf message definition generated by
/// the rust module prost-build.
pub mod proto {
    include!("qaul.net.messaging.rs");
}

/// mutable state of messages, scheduled for sending
pub static MESSAGING: Storage<RwLock<Messaging>> = Storage::new();

/// Messaging Scheduling Structure
pub struct ScheduledMessage {
    receiver: PeerId,
    container: proto::Container,
    is_common: bool,
    is_forward: bool,
    scheduled_dtn: bool,
    is_dtn: bool,
}

/// mutable state of messages, scheduled for sending
pub static UNCONFIRMED: Storage<RwLock<UnConfirmedMessages>> = Storage::new();

// TODO: check if it wouldn't be easier to store
// the message
/// unconfirmed message
#[derive(Serialize, Deserialize, Clone)]
pub struct UnConfirmedMessage {
    // receiver id
    pub receiver_id: Vec<u8>,
    // message type
    pub message_type: MessagingServiceType,
    // message id
    pub message_id: Vec<u8>,
    // encoded container
    pub container: Vec<u8>,
    // last sent time
    pub last_sent: u64,
    // retry time
    pub retry: u32,
    // flag that transferred on the network
    pub scheduled: bool,
    // flag that transferred as DTN service
    pub scheduled_dtn: bool,
    // flag that indicate DTN message
    pub is_dtn: bool,
}

/// Unconfirmed Message Type
#[derive(Serialize, Deserialize, Clone)]
pub enum MessagingServiceType {
    /// Unconfirmed Message
    /// (this message does expect a confirmation)
    Unconfirmed,
    /// DTN message, originated from this host
    DtnOrigin,
    /// DTN message, stored on this host
    DtnStored,
    /// Crypto Handshake Message
    Crypto,
    /// Group Management Message
    Group,
    /// Chat Text Message
    Chat,
    /// Chat File Message
    ChatFile,
    /// RTC Message
    Rtc,
}

/// Unconfirmed Messages Structure
pub struct UnConfirmedMessages {
    /// signature => UnConfirmedMessage
    pub unconfirmed: Tree<UnConfirmedMessage>,
}

/// Qaul Messaging Structure
pub struct Messaging {
    /// ring buffer of messages scheduled for sending
    pub to_send: VecDeque<ScheduledMessage>,
}

/// Qaul Failed Message Structure
#[derive(Serialize, Deserialize, Clone)]
pub struct FailedMessage {
    pub user_id: Vec<u8>,
    pub group_id: Vec<u8>,
    pub created_at: u64,
    pub last_try: u64,
    pub try_count: u32,
    pub message: String,
}

impl Messaging {
    /// Initialize messaging and create the ring buffer.
    pub fn init() {
        #[cfg(emulate)]
        /// init emulator
        network_emul::NetworkEmulator::init();

        let messaging = Messaging {
            to_send: VecDeque::new(),
        };
        MESSAGING.set(RwLock::new(messaging));

        let db = DataBase::get_node_db();

        // open trees
        let unconfirmed: Tree<UnConfirmedMessage> = db.open_bincode_tree("unconfirmed").unwrap();
        let unconfirmed_messages = UnConfirmedMessages { unconfirmed };
        UNCONFIRMED.set(RwLock::new(unconfirmed_messages));
    }

    /// Save a message to the data base to wait for confirmation
    pub fn save_unconfirmed_message(
        message_type: MessagingServiceType,
        message_id: &Vec<u8>,
        receiver: &PeerId,
        container: &proto::Container,
        is_dtn: bool,
    ) {
        let new_entry = UnConfirmedMessage {
            receiver_id: receiver.to_bytes(),
            container: container.encode_to_vec(),
            last_sent: Timestamp::get_timestamp(),
            message_type,
            message_id: message_id.to_owned(),
            retry: 1,
            scheduled: false,
            scheduled_dtn: false,
            is_dtn,
        };
        let unconfirmed = UNCONFIRMED.get().write().unwrap();

        // insert message to data base
        if let Err(e) = unconfirmed
            .unconfirmed
            .insert(container.signature.clone(), new_entry)
        {
            log::error!("{}", e);
        }
        // flush
        if let Err(e) = unconfirmed.unconfirmed.flush() {
            log::error!("Error unconfirmed table flush: {}", e);
        }
    }

    /// process confirmation message and return (sender_id, message_id)
    pub fn on_confirmed_message(
        signature: &Vec<u8>,
        sender_id: PeerId,
        user_account: UserAccount,
        confirmation: proto::Confirmation,
    ) {
        log::trace!("message confirmed");

        let unconfirmed = UNCONFIRMED.get().write().unwrap();

        // check and remove unconfirmed from DB
        match unconfirmed.unconfirmed.remove(signature) {
            Ok(v) => {
                if let Err(e) = unconfirmed.unconfirmed.flush() {
                    log::error!("Error unconfirmed table flush: {}", e);
                }

                match v {
                    Some(unconfirmed) => {
                        // check message and decide what to do
                        match unconfirmed.message_type {
                            MessagingServiceType::Unconfirmed => {
                                log::trace!("Confirmation: Unconfirmed");
                            }
                            MessagingServiceType::DtnOrigin => {
                                log::trace!("Confirmation: DtnOrigin");
                                // what kind of message do we have here?
                                // TODO: check chat storage as sent ...
                            }
                            MessagingServiceType::DtnStored => {
                                log::trace!("Confirmation: DtnStored");
                            }
                            MessagingServiceType::Crypto => {
                                log::trace!("Confirmation: Crypto");
                            }
                            MessagingServiceType::Group => {
                                log::trace!("Confirmation: Group");
                                // don't do anything for group messages
                            }
                            MessagingServiceType::Chat => {
                                log::trace!("Confirmation: Chat");
                                // set received info in chat data base
                                ChatStorage::update_confirmation(
                                    user_account.id,
                                    sender_id,
                                    &unconfirmed.message_id,
                                    confirmation.received_at,
                                );
                            }
                            MessagingServiceType::ChatFile => {
                                log::trace!("Confirmation: ChatFile");
                                match unconfirmed.message_id.try_into() {
                                    Ok(arr) => {
                                        let file_id = u64::from_be_bytes(arr);

                                        // confirm message reception in data base
                                        ChatFile::update_confirmation(
                                            user_account.id,
                                            sender_id,
                                            file_id,
                                            confirmation.received_at,
                                        );
                                    }
                                    Err(e) => {
                                        log::error!("couldn't convert file_id to u64: {:?}", e);
                                    }
                                }
                            }
                            MessagingServiceType::Rtc => {
                                log::trace!("Confirmation: Rtc");
                                // TODO CONFIRM RTC MESSAGE
                            }
                        }
                    }
                    _ => {}
                }
            }
            Err(e) => {
                log::error!("{}", e);
            }
        }
    }

    fn on_scheduled_message(signature: &Vec<u8>) {
        let unconfirmed = UNCONFIRMED.get().write().unwrap();
        if !unconfirmed.unconfirmed.contains_key(signature).unwrap() {
            return;
        }

        let mut unconfirmed_message = unconfirmed.unconfirmed.get(signature).unwrap().unwrap();
        if unconfirmed_message.scheduled {
            return;
        }

        unconfirmed_message.scheduled = true;
        if let Err(_e) = unconfirmed
            .unconfirmed
            .insert(signature.clone(), unconfirmed_message)
        {
            log::error!("error updating unconfirmed table");
        } else {
            if let Err(_e) = unconfirmed.unconfirmed.flush() {
                log::error!("error updating unconfirmed table");
            }
        }
    }

    fn on_scheduled_as_dtn_message(signature: &Vec<u8>) {
        let unconfirmed = UNCONFIRMED.get().write().unwrap();
        if !unconfirmed.unconfirmed.contains_key(signature).unwrap() {
            return;
        }

        let mut unconfirmed_message = unconfirmed.unconfirmed.get(signature).unwrap().unwrap();
        if unconfirmed_message.scheduled {
            return;
        }

        unconfirmed_message.scheduled_dtn = true;
        if let Err(_e) = unconfirmed
            .unconfirmed
            .insert(signature.clone(), unconfirmed_message)
        {
            log::error!("error updating unconfirmed table");
        } else {
            if let Err(_e) = unconfirmed.unconfirmed.flush() {
                log::error!("error updating unconfirmed table");
            }
        }
    }

    /// pack, sign and schedule a message for sending
    pub fn pack_and_send_message(
        user_account: &UserAccount,
        receiver: &PeerId,
        data: Vec<u8>,
        _message_type: MessagingServiceType,
        message_id: &Vec<u8>,
        is_common_message: bool,
    ) -> Result<Vec<u8>, String> {
        log::trace!("pack_and_send_message to {}", receiver.to_base58());

        // encrypt data
        let encrypted_message: proto::Encrypted;
        let encryption_result = Crypto::encrypt(data, user_account.to_owned(), receiver.clone());

        match encryption_result {
            Some(encrypted) => {
                encrypted_message = encrypted;
            }
            None => return Err("Encryption error occurred".to_string()),
        }

        log::trace!(
            "sender_id: {}, receiver_id: {}",
            user_account.id.to_base58(),
            receiver.to_base58()
        );

        let envelop_payload = proto::EnvelopPayload {
            payload: Some(proto::envelop_payload::Payload::Encrypted(
                encrypted_message,
            )),
        };

        // create envelope
        let envelope = proto::Envelope {
            sender_id: user_account.id.to_bytes(),
            receiver_id: receiver.to_bytes(),
            payload: envelop_payload.encode_to_vec(),
        };

        // encode envelope
        let mut envelope_buf = Vec::with_capacity(envelope.encoded_len());
        envelope
            .encode(&mut envelope_buf)
            .expect("Vec<u8> provides capacity as needed");

        // sign message
        if let Ok(signature) = user_account.keys.sign(&envelope_buf) {
            // create container
            let container = proto::Container {
                signature: signature.clone(),
                envelope: Some(envelope),
            };

            // in common message case, save into unconfirmed table
            if is_common_message {
                Self::save_unconfirmed_message(
                    MessagingServiceType::Chat,
                    message_id,
                    receiver,
                    &container,
                    false,
                );
            }

            // schedule message for sending
            Self::schedule_message(
                receiver.clone(),
                container,
                is_common_message,
                false,
                false,
                false,
            );

            // return signature
            Ok(signature)
        } else {
            return Err("messaging signing error".to_string());
        }
    }

    /// pack, sign and schedule a message for sending
    pub fn send_dtn_message(
        user_account: &UserAccount,
        storage_node_id: &PeerId,
        org_container: &proto::Container,
    ) -> Result<Vec<u8>, String> {
        // create Dtn message
        let dtn_payload = proto::EnvelopPayload {
            payload: Some(proto::envelop_payload::Payload::Dtn(
                org_container.encode_to_vec(),
            )),
        };
        let envelope_dtn = proto::Envelope {
            sender_id: user_account.id.to_bytes(),
            receiver_id: storage_node_id.to_bytes(),
            payload: dtn_payload.encode_to_vec(),
        };

        if let Ok(signature_dtn) = user_account.keys.sign(&envelope_dtn.encode_to_vec()) {
            // create dtn container
            let container_dtn = proto::Container {
                signature: signature_dtn.clone(),
                envelope: Some(envelope_dtn),
            };

            // in common message case, save into unconfirmed table
            Self::save_unconfirmed_message(
                MessagingServiceType::Chat,
                &Vec::new(),
                &storage_node_id,
                &container_dtn,
                true,
            );

            // schedule message for sending
            Self::schedule_message(
                storage_node_id.clone(),
                container_dtn,
                true,
                false,
                true,
                true,
            );

            // return signature
            Ok(signature_dtn)
        } else {
            return Err("dtn messaging signing error".to_string());
        }
    }

    /// schedule a message
    ///
    /// schedule a message for sending.
    /// This function adds the message to the ring buffer for sending.
    /// This buffer is checked regularly by libqaul for sending.
    ///
    pub fn schedule_message(
        receiver: PeerId,
        container: proto::Container,
        is_common: bool,
        is_forward: bool,
        scheduled_dtn: bool,
        is_dtn: bool,
    ) {
        #[cfg(emulate)]
        if network_emul::NetworkEmulator::is_lost() {
            log::error!(
                "drop message, signature: {}",
                bs58::encode(container.signature.clone()).into_string()
            );
            return;
        }

        let msg = ScheduledMessage {
            receiver,
            container,
            is_common,
            is_forward,
            scheduled_dtn,
            is_dtn,
        };

        // add it to sending queue
        let mut messaging = MESSAGING.get().write().unwrap();
        messaging.to_send.push_back(msg);
    }

    /// Check Scheduler
    ///
    /// Check if there is a message scheduled for sending.
    ///
    pub fn check_scheduler() -> Option<(PeerId, ConnectionModule, Vec<u8>)> {
        let message_item: Option<ScheduledMessage>;

        // get scheduled messaging buffer
        {
            let mut messaging = MESSAGING.get().write().unwrap();
            message_item = messaging.to_send.pop_front();
        }

        if let Some(message) = message_item {
            // check for route
            if let Some(route) = RoutingTable::get_route_to_user(message.receiver) {
                // update unconfirmed table set scheduled flag.
                Self::on_scheduled_message(&message.container.signature);

                // create binary message
                let data = message.container.encode_to_vec();

                // return information
                return Some((route.node, route.module, data));
            } else {
                // user is offline we schedule through DTN service
                if !message.is_forward
                    && !message.is_dtn
                    && !message.scheduled_dtn
                    && message.is_common
                {
                    // get storage node id
                    if let Ok(my_user_id) =
                        PeerId::from_bytes(&message.container.envelope.as_ref().unwrap().sender_id)
                    {
                        if let Some(storage_node_id) =
                            super::dtn::Dtn::get_storage_user(&my_user_id)
                        {
                            if let Some(user_account) = UserAccounts::get_by_id(my_user_id) {
                                if let Err(_e) = Self::send_dtn_message(
                                    &user_account,
                                    &storage_node_id,
                                    &message.container,
                                ) {
                                    log::error!("DTN scheduling error!");
                                } else {
                                    log::error!("DTN scheduled...");
                                    // update unconfirmed table
                                    Self::on_scheduled_as_dtn_message(&message.container.signature);
                                }
                            }
                        }
                    }
                }
            }
        }

        None
    }

    /// Send a confirmation message for a received message
    pub fn send_confirmation(
        user_id: &PeerId,
        receiver_id: &PeerId,
        signature: &Vec<u8>,
    ) -> Result<Vec<u8>, String> {
        if let Some(user) = UserAccounts::get_by_id(user_id.clone()) {
            // create timestamp
            let timestamp = Timestamp::get_timestamp();

            // pack message
            let send_message = proto::Messaging {
                message: Some(proto::messaging::Message::ConfirmationMessage(
                    proto::Confirmation {
                        signature: signature.clone(),
                        received_at: timestamp,
                    },
                )),
            };

            // encode chat message
            let mut message_buf = Vec::with_capacity(send_message.encoded_len());
            send_message
                .encode(&mut message_buf)
                .expect("Vec<u8> provides capacity as needed");

            // send message via messaging
            let message_id: Vec<u8> = Vec::new();
            Self::pack_and_send_message(
                &user,
                receiver_id,
                message_buf,
                MessagingServiceType::Unconfirmed,
                &message_id,
                false,
            )
        } else {
            return Err("invalid user_id".to_string());
        }
    }

    /// received message from qaul_messaging behaviour
    pub fn received(received: QaulMessagingReceived) {
        // decode message container
        match proto::Container::decode(&received.data[..]) {
            Ok(container) => {
                if let Some(envelope) = container.envelope.clone() {
                    match PeerId::from_bytes(&envelope.receiver_id) {
                        Ok(receiver_id) => {
                            // check if message is local user account
                            match UserAccounts::get_by_id(receiver_id) {
                                // we are the receiving node,
                                // process and save the message
                                Some(user_account) => MessagingProcess::process_received_message(
                                    user_account,
                                    container,
                                ),

                                // schedule it for further sending otherwise
                                None => Self::schedule_message(
                                    receiver_id,
                                    container,
                                    true,
                                    true,
                                    false,
                                    false,
                                ),
                            }
                        }
                        Err(e) => log::error!(
                            "invalid peer ID of message {}: {}",
                            bs58::encode(container.signature).into_string(),
                            e
                        ),
                    }
                }
            }
            Err(e) => log::error!("Messaging container decoding error: {}", e),
        }
    }
}