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
// Copyright (C) 2022  Aravinth Manivannan <realaravinth@batsense.net>
// SPDX-FileCopyrightText: 2023 Aravinth Manivannan <realaravinth@batsense.net>
//
// SPDX-License-Identifier: AGPL-3.0-or-later

use std::path::Path;
use std::{env, fs};

use config::builder::DefaultState;
use config::{Config, ConfigBuilder, ConfigError, File};
use derive_more::Display;

use serde::{Deserialize, Serialize};
use url::Url;

#[derive(Debug, Clone, Deserialize, Eq, PartialEq)]
pub struct Server {
    pub port: u32,
    pub domain: String,
    pub cookie_secret: String,
    pub ip: String,
    // TODO: remove
    pub url_prefix: Option<String>,
    pub proxy_has_tls: bool,
}

#[derive(Debug, Clone, Deserialize, Eq, PartialEq)]
pub struct Captcha {
    pub salt: String,
    pub gc: u64,
    pub runners: Option<usize>,
    pub queue_length: usize,
    pub enable_stats: bool,
    pub default_difficulty_strategy: DefaultDifficultyStrategy,
}

#[derive(Debug, Clone, Deserialize, Eq, PartialEq)]
pub struct DefaultDifficultyStrategy {
    pub avg_traffic_difficulty: u32,
    pub broke_my_site_traffic_difficulty: u32,
    pub peak_sustainable_traffic_difficulty: u32,
    pub duration: u32,
}

#[derive(Debug, Clone, Deserialize, Eq, PartialEq)]
pub struct Smtp {
    pub from: String,
    pub reply: String,
    pub url: String,
    pub username: String,
    pub password: String,
    pub port: u16,
}

impl Server {
    #[cfg(not(tarpaulin_include))]
    pub fn get_ip(&self) -> String {
        format!("{}:{}", self.ip, self.port)
    }
}

#[derive(Deserialize, Serialize, Display, Eq, PartialEq, Clone, Debug)]
#[serde(rename_all = "lowercase")]
pub enum DBType {
    #[display(fmt = "postgres")]
    Postgres,
    #[display(fmt = "maria")]
    Maria,
}

impl DBType {
    fn from_url(url: &Url) -> Result<Self, ConfigError> {
        match url.scheme() {
            "mysql" => Ok(Self::Maria),
            "postgres" => Ok(Self::Postgres),
            _ => Err(ConfigError::Message("Unknown database type".into())),
        }
    }
}

#[derive(Debug, Clone, Deserialize, Eq, PartialEq)]
pub struct Database {
    pub url: String,
    pub pool: u32,
    pub database_type: DBType,
}

#[derive(Debug, Clone, Deserialize, Eq, PartialEq)]
pub struct Redis {
    pub url: String,
    pub pool: u32,
}

#[derive(Debug, Clone, Deserialize, Eq, PartialEq)]
pub struct Settings {
    pub debug: bool,
    pub commercial: bool,
    pub source_code: String,
    pub allow_registration: bool,
    pub allow_demo: bool,
    pub database: Database,
    pub redis: Option<Redis>,
    pub server: Server,
    pub captcha: Captcha,
    pub smtp: Option<Smtp>,
}

const ENV_VAR_CONFIG: [(&str, &str); 29] = [
    /* top-level */
    ("debug", "MCAPTCHA_debug"),
    ("commercial", "MCAPTCHA_commercial"),
    ("source_code", "MCAPTCHA_source_code"),
    ("allow_registration", "MCAPTCHA_allow_registration"),
    ("allow_demo", "MCAPTCHA_allow_demo"),

    /* database */
    ("database.url", "DATABASE_URL"),
    ("database.pool", "MCAPTCHA_database_POOL"),

    /* redis */
    ("redis.url", "MCPATCHA_redis_URL"),
    ("redis.pool", "MCPATCHA_redis_POOL"),

    /* server */
    ("server.port", "PORT"),
    ("server.domain", "MCAPTCHA_server_DOMAIN"),
    ("server.cookie_secret", "MCAPTCHA__server_COOKIE_SECRET"),
    ("server.ip", "MCAPTCHA__server_IP"),
    ("server.proxy_has_tls", "MCAPTCHA__server_PROXY_HAS_TLS"),


    /* captcha */
    ("captcha.salt", "MCAPTCHA_captcha_SALT"),
    ("captcha.gc", "MCAPTCHA_captcha_GC"),
    ("captcha.runners", "MCAPTCHA_captcha_RUNNERS"),
    ("captcha.queue_length", "MCAPTCHA_captcha_QUEUE_LENGTH"),
    ("captcha.enable_stats", "MCAPTCHA_captcha_ENABLE_STATS"),
    ("captcha.default_difficulty_strategy.avg_traffic_difficulty", "MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_avg_traffic_difficulty"),
    ("captcha.default_difficulty_strategy.broke_my_site_traffic_difficulty", "MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_broke_my_site_traffic_difficulty"),
    ("captcha.default_difficulty_strategy.peak_sustainable_traffic_difficulty",
     "MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_peak_sustainable_traffic_difficulty"),
    ( "captcha.default_difficulty_strategy.duration",
         "MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_duration"
     ),


    /* SMTP */
    ("smtp.from", "MCPATCHA_smtp_FROM"),
    ("smtp.reply", "MCPATCHA_smtp_REPLY"),
    ("smtp.url", "MCPATCHA_smtp_URL"),
    ("smtp.username", "MCPATCHA_smtp_USERNAME"),
    ("smtp.password", "MCPATCHA_smtp_PASSWORD"),
    ("smtp.port", "MCPATCHA_smtp_PORT"),



];

#[cfg(not(tarpaulin_include))]
impl Settings {
    pub fn new() -> Result<Self, ConfigError> {
        let mut s = Config::builder();

        const CURRENT_DIR: &str = "./config/default.toml";
        const ETC: &str = "/etc/mcaptcha/config.toml";

        s = s
            .set_default("capatcha.enable_stats", true.to_string())
            .expect("unable to set capatcha.enable_stats default config");

        // Will be overridden after config is parsed and loaded into Settings by
        // Settings::set_database_type.
        // This parameter is not ergonomic for users, but it is required and can be programatically
        // inferred. But we need a default value for config lib to parse successfully, since it is
        // DBType and not Option<DBType>
        s = s
            .set_default("database.database_type", DBType::Postgres.to_string())
            .expect("unable to set database.database_type default config");

        if let Ok(path) = env::var("MCAPTCHA_CONFIG") {
            let absolute_path = Path::new(&path).canonicalize().unwrap();
            log::info!(
                "Loading config file from {}",
                absolute_path.to_str().unwrap()
            );
            s = s.add_source(File::with_name(absolute_path.to_str().unwrap()));
        } else if Path::new(CURRENT_DIR).exists() {
            let absolute_path = fs::canonicalize(CURRENT_DIR).unwrap();
            log::info!(
                "Loading config file from {}",
                absolute_path.to_str().unwrap()
            );
            // merging default config from file
            s = s.add_source(File::with_name(absolute_path.to_str().unwrap()));
        } else if Path::new(ETC).exists() {
            log::info!("{}", format!("Loading config file from {}", ETC));
            s = s.add_source(File::with_name(ETC));
        } else {
            log::warn!("Configuration file not found");
        }

        s = Self::env_override(s);

        let mut settings = s.build()?.try_deserialize::<Settings>()?;
        settings.check_url();

        settings.set_database_type();

        Ok(settings)
    }

    fn env_override(mut s: ConfigBuilder<DefaultState>) -> ConfigBuilder<DefaultState> {
        for (parameter, env_var_name) in ENV_VAR_CONFIG.iter() {
            if let Ok(val) = env::var(env_var_name) {
                log::debug!(
                    "Overriding [{parameter}] with environment variable {env_var_name}"
                );
                s = s.set_override(parameter, val).unwrap();
            }
        }

        s
    }

    fn set_database_type(&mut self) {
        let url = Url::parse(&self.database.url)
            .expect("couldn't parse Database URL and detect database type");
        self.database.database_type = DBType::from_url(&url).unwrap();
    }

    fn check_url(&self) {
        Url::parse(&self.source_code)
            .expect("Please enter a URL for source_code in settings");
    }
}

#[cfg(test)]
mod tests {

    use super::*;

    #[test]
    fn env_override_works() {
        use crate::tests::get_settings;
        let init_settings = get_settings();
        // so that it can be tested outside the macro (helper) too
        let mut new_settings;

        macro_rules! helper {




            ($env:expr, $val:expr, $val_typed:expr, $($param:ident).+) => {
                println!("Setting env var {} to {} for test", $env, $val);
                env::set_var($env, $val);
                new_settings = get_settings();
                assert_eq!(new_settings.$($param).+, $val_typed);
                assert_ne!(new_settings.$($param).+, init_settings.$($param).+);
                env::remove_var($env);
            };


            ($env:expr, $val:expr, $($param:ident).+) => {
                helper!($env, $val.to_string(), $val, $($param).+);
            };
        }

        /* top level */
        helper!("MCAPTCHA_debug", false, debug);
        helper!("MCAPTCHA_commercial", true, commercial);
        helper!("MCAPTCHA_allow_registration", false, allow_registration);
        helper!("MCAPTCHA_allow_demo", false, allow_demo);

        /* database_type */

        helper!(
            "DATABASE_URL",
            "postgres://postgres:password@localhost:5432/postgres",
            database.url
        );
        assert_eq!(new_settings.database.database_type, DBType::Postgres);
        helper!(
            "DATABASE_URL",
            "mysql://maria:password@localhost/maria",
            database.url
        );
        assert_eq!(new_settings.database.database_type, DBType::Maria);
        helper!("MCAPTCHA_database_POOL", 1000, database.pool);

        /* redis */

        /* redis.url */
        let env = "MCPATCHA_redis_URL";
        let val = "redis://redis.example.org";
        println!("Setting env var {} to {} for test", env, val);
        env::set_var(env, val);
        new_settings = get_settings();
        assert_eq!(new_settings.redis.as_ref().unwrap().url, val);
        assert_ne!(
            new_settings.redis.as_ref().unwrap().url,
            init_settings.redis.as_ref().unwrap().url
        );
        env::remove_var(env);

        /* redis.pool */
        let env = "MCPATCHA_redis_POOL";
        let val = 999;
        println!("Setting env var {} to {} for test", env, val);
        env::set_var(env, val.to_string());
        new_settings = get_settings();
        assert_eq!(new_settings.redis.as_ref().unwrap().pool, val);
        assert_ne!(
            new_settings.redis.as_ref().unwrap().pool,
            init_settings.redis.as_ref().unwrap().pool
        );
        env::remove_var(env);

        helper!("PORT", 0, server.port);
        helper!("MCAPTCHA_server_DOMAIN", "example.org", server.domain);
        helper!(
            "MCAPTCHA__server_COOKIE_SECRET",
            "dafasdfsdf",
            server.cookie_secret
        );
        helper!("MCAPTCHA__server_IP", "9.9.9.9", server.ip);
        helper!("MCAPTCHA__server_PROXY_HAS_TLS", true, server.proxy_has_tls);

        /* captcha */

        helper!("MCAPTCHA_captcha_SALT", "foobarasdfasdf", captcha.salt);
        helper!("MCAPTCHA_captcha_GC", 500, captcha.gc);
        helper!(
            "MCAPTCHA_captcha_RUNNERS",
            "500",
            Some(500),
            captcha.runners
        );

        helper!("MCAPTCHA_captcha_QUEUE_LENGTH", 500, captcha.queue_length);
        helper!("MCAPTCHA_captcha_ENABLE_STATS", false, captcha.enable_stats);
        helper!(
            "MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_avg_traffic_difficulty",
            999,
            captcha.default_difficulty_strategy.avg_traffic_difficulty
        );
        helper!("MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_peak_sustainable_traffic_difficulty", 999 , captcha.default_difficulty_strategy.peak_sustainable_traffic_difficulty);
        helper!("MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_broke_my_site_traffic_difficulty", 999 , captcha.default_difficulty_strategy.broke_my_site_traffic_difficulty);
        helper!(
            "MCAPTCHA_captcha_DEFAULT_DIFFICULTY_STRATEGY_duration",
            999,
            captcha.default_difficulty_strategy.duration
        );

        /* SMTP */

        let vals = [
            "MCPATCHA_smtp_FROM",
            "MCPATCHA_smtp_REPLY",
            "MCPATCHA_smtp_URL",
            "MCPATCHA_smtp_USERNAME",
            "MCPATCHA_smtp_PASSWORD",
            "MCPATCHA_smtp_PORT",
        ];
        for env in vals.iter() {
            println!("Setting env var {} to {} for test", env, env);
            env::set_var(env, env);
        }

        let port = 9999;
        env::set_var("MCPATCHA_smtp_PORT", port.to_string());

        new_settings = get_settings();
        let smtp_new = new_settings.smtp.as_ref().unwrap();
        let smtp_old = init_settings.smtp.as_ref().unwrap();
        assert_eq!(smtp_new.from, "MCPATCHA_smtp_FROM");
        assert_eq!(smtp_new.reply, "MCPATCHA_smtp_REPLY");
        assert_eq!(smtp_new.username, "MCPATCHA_smtp_USERNAME");
        assert_eq!(smtp_new.password, "MCPATCHA_smtp_PASSWORD");
        assert_eq!(smtp_new.port, port);
        assert_ne!(smtp_new, smtp_old);

        for env in vals.iter() {
            env::remove_var(env);
        }
    }

    //    #[test]
    //    fn url_prefix_test() {
    //        let mut settings = Settings::new().unwrap();
    //        assert!(settings.server.url_prefix.is_none());
    //        settings.server.url_prefix = Some("test".into());
    //        settings.server.check_url_prefix();
    //        settings.server.url_prefix = Some("    ".into());
    //        settings.server.check_url_prefix();
    //        assert!(settings.server.url_prefix.is_none());
    //    }
    //
    //    #[test]
    //    fn smtp_config_works() {
    //        let settings = Settings::new().unwrap();
    //        assert!(settings.smtp.is_some());
    //        assert_eq!(settings.smtp.as_ref().unwrap().password, "password");
    //        assert_eq!(settings.smtp.as_ref().unwrap().username, "admin");
    //    }
}