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
// Copyright (c) 2021 Open Community Project Association https://ocpa.ch
// This software is published under the AGPLv3 license.

//! # Configuration
//!
//! **Configure qaul.net via a config file, or from the commandline.**
//!
//! On the first startup a `config.yaml` file is saved.
//! It can be configured and will be read on the next startup.
//! All options are configurable from the commandline too.

use config::{Config, File};
use serde::{Deserialize, Serialize};
use state::Storage;
use std::{
    fs,
    path::Path,
    sync::{RwLock, RwLockReadGuard, RwLockWriteGuard},
};

/// make configuration globally accessible mutable state
static CONFIG: Storage<RwLock<Configuration>> = Storage::new();

/// Configuration of the local Node
///
/// Here the keys and identity are stored
#[derive(Debug, Deserialize, Clone, Serialize)]
pub struct Node {
    pub initialized: u8,
    pub id: String,
    pub keys: String,
}

impl Default for Node {
    fn default() -> Self {
        Node {
            initialized: 0,
            id: String::from(""),
            keys: String::from(""),
        }
    }
}

/// LAN Connection Module
#[derive(Debug, Deserialize, Clone, Serialize)]
pub struct Lan {
    pub active: bool,
    pub listen: String,
}

impl Default for Lan {
    fn default() -> Self {
        Lan {
            active: true,
            listen: String::from("/ip4/0.0.0.0/tcp/0"),
        }
    }
}

#[derive(Debug, Deserialize, Clone, Serialize)]
pub struct InternetPeer {
    pub address: String,
    pub enabled: bool,
}

/// Internet Overlay Connection Module
#[derive(Debug, Deserialize, Clone, Serialize)]
pub struct Internet {
    pub active: bool,
    pub peers: Vec<InternetPeer>,
    pub do_listen: bool,
    pub listen: String,
}

impl Default for Internet {
    fn default() -> Self {
        let mut listen_str: String = "/ip4/0.0.0.0/tcp/".to_string();
        let mut port: u16 = 0;
        if let Some(port_str) = super::super::get_default_config("port") {
            match port_str.parse::<u16>() {
                Ok(p) => {
                    port = p;
                }
                _ => {}
            }
        }
        listen_str.push_str(port.to_string().as_str());

        Internet {
            active: true,
            peers: vec![InternetPeer {
                address: String::from("/ip4/144.91.74.192/tcp/9229"),
                enabled: false,
            }],
            do_listen: false,
            #[cfg(any(target_os = "android", target_os = "ios"))]
            listen: String::from("/ip4/0.0.0.0/tcp/9229"),
            #[cfg(not(any(target_os = "android", target_os = "ios")))]
            listen: listen_str.clone(),
        }
    }
}

/// local user accounts that are stored on this node
#[derive(Debug, Deserialize, Clone, Serialize)]
pub struct UserAccount {
    pub name: String,
    pub id: String,
    pub keys: String,
    pub storage: StorageOptions,
}

impl Default for UserAccount {
    fn default() -> Self {
        UserAccount {
            name: String::from(""),
            id: String::from(""),
            keys: String::from(""),
            storage: StorageOptions::default(),
        }
    }
}

/// Debugging Configuration Options
///
/// The following options can be configured:
///
/// * logging to file
#[derive(Debug, Deserialize, Clone, Serialize)]
pub struct DebugOption {
    pub log: bool,
}

impl Default for DebugOption {
    fn default() -> Self {
        DebugOption { log: false }
    }
}

/// Routing Configuration Options
///
/// The following options can be configured:
/// All units are second
/// because rtt is measured as micro seconds
/// * routing options
#[derive(Debug, Deserialize, Clone, Serialize)]
pub struct RoutingOptions {
    //Sending the table every 10 seconds to direct neighbours.
    pub sending_table_period: u64,
    //Pinging every neighbour all 5 seconds.
    pub ping_neighbour_period: u64,
    //Hop count penalty.
    pub hop_count_penalty: u64,
    //How long a route is stored until it is removed.
    pub maintain_period_limit: u64,
}

impl Default for RoutingOptions {
    fn default() -> Self {
        RoutingOptions {
            sending_table_period: 10,   //10 seconds, unit seconds
            ping_neighbour_period: 5,   //5  seconds, unit: seconds
            hop_count_penalty: 10,      //10 seconds, unit: second
            maintain_period_limit: 300, //5min, unit: second
        }
    }
}

/// Storage Configuration Options
///
/// The following options can be configured:
/// size_total units are MB
/// * storage options
#[derive(Debug, Deserialize, Clone, Serialize)]
pub struct StorageOptions {
    //storage node users
    pub users: Vec<String>,
    //Sending the table every 10 seconds to direct neighbours.
    pub size_total: u32,
}

impl Default for StorageOptions {
    fn default() -> Self {
        StorageOptions {
            users: vec![],
            size_total: 1024, //1024 MB
        }
    }
}

/// Configuration Structure of libqaul
///
/// This structure contains the entire configuration of libqaul.
#[derive(Debug, Deserialize, Clone, Serialize)]
pub struct Configuration {
    pub node: Node,
    pub lan: Lan,
    pub internet: Internet,
    pub user_accounts: Vec<UserAccount>,
    pub debug: DebugOption,
    pub routing: RoutingOptions,
}

impl Default for Configuration {
    fn default() -> Self {
        Configuration {
            node: Node::default(),
            lan: Lan::default(),
            internet: Internet::default(),
            user_accounts: Vec::new(),
            debug: DebugOption::default(),
            routing: RoutingOptions::default(),
        }
    }
}

/// Configuration implementation of libqaul
impl Configuration {
    /// Initialize configuration
    pub fn init() {
        let mut settings = Config::default();

        // create configuration path
        let path_string = super::Storage::get_path();
        let path = Path::new(path_string.as_str());
        let config_path = path.join("config.yaml");

        // Merge config if a Config file exists
        let config: Configuration =
            match settings.merge(File::with_name(&config_path.to_str().unwrap())) {
                Err(_) => {
                    log::error!("no configuration file found, creating one.");
                    Configuration::default()
                }
                Ok(c) => c
                    .clone()
                    .try_into()
                    .expect("Couldn't Convert to `Configuration`, malformed config file."),
            };

        // There is no key for debug in the the configuration hence fails.

        // Add configuration options from environment variables (with a prefix of QAUL)
        // e.g. `QAUL_DEBUG=1 ./target/qaul` sets the `debug` key

        // match e.merge(Environment::with_prefix("QAUL")) {
        //     Ok(env) => settings = env.clone(),
        //     Err(e) => error!("Environment {:?}", e),
        // }

        // put configuration to state
        CONFIG.set(RwLock::new(config));
    }

    /// lend configuration for reading
    pub fn get<'a>() -> RwLockReadGuard<'a, Configuration> {
        let config = CONFIG.get().read().unwrap();
        config
    }

    /// get user account
    pub fn get_user(user_id: String) -> Option<UserAccount> {
        let config = CONFIG.get().read().unwrap();
        for user in &config.user_accounts {
            if user.id == user_id {
                return Some(user.clone());
            }
        }
        None
    }

    // CHANGE: remove this function & save configuration directly via UserAccount
    pub fn update_user_storage(user_id: String, opt: &StorageOptions) {
        let mut config = CONFIG.get().write().unwrap();
        for i in 0..config.user_accounts.len() {
            if let Some(user) = config.user_accounts.get_mut(i) {
                if user.id == user_id {
                    user.storage = opt.clone();
                    break;
                }
            }
        }
    }

    // CHANGE: remove this function and save configuration directly via UserAccount
    pub fn update_total_size(user_id: String, size: u32) {
        let mut config = CONFIG.get().write().unwrap();
        for i in 0..config.user_accounts.len() {
            if let Some(user) = config.user_accounts.get_mut(i) {
                if user.id == user_id {
                    user.storage.size_total = size;
                    break;
                }
            }
        }
    }

    /// lend configuration for writing
    pub fn get_mut<'a>() -> RwLockWriteGuard<'a, Configuration> {
        let config_mutable = CONFIG.get().write().unwrap();
        config_mutable
    }

    /// Enable/disable logging to file for debugging
    pub fn enable_debug_log(enable: bool) {
        let mut config_mutable = CONFIG.get().write().unwrap();
        config_mutable.debug.log = enable;
    }

    /// Check if logging to file for debugging is enabled
    pub fn get_debug_log() -> bool {
        let config_mutable = CONFIG.get().read().unwrap();
        config_mutable.debug.log
    }

    /// Returns true/false whether this node has been initialized,
    /// or needs to be created for the first time.
    pub fn is_node_initialized() -> bool {
        let config = CONFIG.get().read().unwrap();
        if config.node.initialized == 0 {
            return false;
        }
        true
    }

    /// Save current configuration to config.yaml file
    pub fn save() {
        let config = CONFIG.get();

        // create yaml configuration format
        let yaml = serde_yaml::to_string(config).expect("Couldn't encode into YAML values.");

        // create path to config file
        let path_string = super::Storage::get_path();
        let path = Path::new(path_string.as_str());
        let config_path = path.join("config.yaml");

        log::trace!("Writing to Path {:?}, {:?}", path, config_path);

        fs::write(config_path.clone(), yaml)
            .expect(&format!("Could not write config to {:?}.", config_path));
    }
}