dev: create new settings implementation.

Author: da2ce7

.gitignore

@@ -4,5 +4,8 @@
 /database.db
 /.idea/
 /config.toml
+/config.toml.old
 /data.db
 /.vscode/launch.json
+/config.backup/
+/config/local.toml

.vscode/settings.json

@@ -1,14 +1,17 @@
 {
     "cSpell.words": [
         "byteorder",
+        "chrono",
         "hasher",
         "leechers",
         "nanos",
+        "nocapture",
         "rngs",
         "Seedable",
         "thiserror",
         "torrust",
-        "typenum"
+        "typenum",
+        "untuple"
     ],
     "[rust]": {
         "editor.formatOnSave": true

Cargo.lock

@@ -59,3 +59,9 @@ async-trait = "0.1"
 
 aquatic_udp_protocol = "0.2"
 uuid = { version = "1", features = ["v4"] }
+
+
+[build-dependencies]
+fs_extra = "1.2.0"
+#copy_to_output = "2"
+glob = "0.3"

Cargo.toml

@@ -0,0 +1,72 @@
+use std::collections::hash_map::DefaultHasher;
+use std::fs::{self, create_dir, rename};
+use std::hash::{Hash, Hasher};
+use std::path::{Path, PathBuf};
+use std::{env, panic};
+
+use fs_extra::copy_items;
+use fs_extra::dir::CopyOptions;
+
+use crate::config_const::{CONFIG_FOLDER, CONFIG_LOCAL};
+
+pub mod config_const {
+    pub const CONFIG_FOLDER: &str = "config";
+    pub const CONFIG_LOCAL: &str = "local";
+}
+
+fn main() {
+    let config_folder = Path::new(CONFIG_FOLDER);
+    let target_folder = env::var_os("OUT_DIR").map(PathBuf::from).unwrap().join("../../..");
+    let local_source = config_folder.join(CONFIG_LOCAL).with_extension("toml");
+    let local_backup_folder = config_folder.with_extension("backup");
+    let local_backup = local_backup_folder.join(CONFIG_LOCAL);
+
+    let t = target_folder.canonicalize();
+
+    eprintln!("Target  : {target_folder:?} : {t:?}");
+
+    // local setting
+    if local_source.exists() {
+        if local_backup_folder.exists() {
+            if !local_backup_folder.is_dir() {
+                panic!("Exists and is not a Folder!: {local_backup_folder:?}")
+            }
+        } else {
+            create_dir(local_backup_folder).unwrap();
+        }
+
+        let mut hasher = DefaultHasher::new();
+
+        fs::read_to_string(&local_source).unwrap().hash(&mut hasher);
+
+        rename(
+            local_source,
+            local_backup.with_extension(format!("{}-{}", "toml", hasher.finish())),
+        )
+        .unwrap();
+    }
+
+    // Re-runs script if any files in config are changed
+    println!("cargo:rerun-if-changed=config/*");
+    copy_to_target(config_folder, &target_folder).expect("Could not copy");
+}
+
+pub fn copy_to_target(path: &Path, target: &Path) -> Result<u64, fs_extra::error::Error> {
+    let mut options = CopyOptions::new();
+    let mut paths = Vec::new();
+
+    // Overwrite existing files with same name
+    options.overwrite = true;
+
+    paths.push(path);
+    match copy_items(&paths, target, &options) {
+        Ok(r) => Ok(r),
+        Err(e) => {
+            let f = path.canonicalize();
+            let t = target.canonicalize();
+            eprintln!("Tried to copy from: {f:?}");
+            eprintln!("Tried to copy to  : {t:?}");
+            Err(e)
+        }
+    }
+}

build.rs

@@ -0,0 +1,38 @@
+## This is the default configuration.
+## The 'local.toml' is where to store your custom configuration.
+
+## The configurations are loaded in this order (low priorty to high):
+## 'config/default.toml'; 'config.toml'; 'config/local.toml'; 'config/override.toml';
+## When loading, the 'local.toml' will be overritten with the active configuration!
+
+log_level = "info"
+mode = "public"
+db_driver = "Sqlite3"
+db_path = "data.db"
+announce_interval = 120
+min_announce_interval = 120
+max_peer_timeout = 900
+on_reverse_proxy = false
+external_ip = "0.0.0.0"
+tracker_usage_statistics = true
+persistent_torrent_completed_stat = false
+inactive_peer_cleanup_interval = 600
+remove_peerless_torrents = true
+
+[[udp_trackers]]
+enabled = false
+bind_address = "0.0.0.0:6969"
+
+[[http_trackers]]
+enabled = false
+bind_address = "0.0.0.0:6969"
+ssl_enabled = false
+ssl_cert_path = ""
+ssl_key_path = ""
+
+[http_api]
+enabled = true
+bind_address = "127.0.0.1:1212"
+
+[http_api.access_tokens]
+admin = "MyAccessToken"

config/default.toml

@@ -0,0 +1,3 @@
+## This is the Override Configuration.
+## This will be used when needing to update values for new versions of the software.
+## Any values placed here will be loaded and will overrite the local configuration file.

config/override.toml

@@ -161,6 +161,7 @@ impl Configuration {
 
 #[cfg(test)]
 mod tests {
+    use crate::config::{Configuration, ConfigurationError};
 
     #[cfg(test)]
     fn default_config_toml() -> String {
@@ -205,8 +206,6 @@ mod tests {
 
     #[test]
     fn configuration_should_have_default_values() {
-        use crate::Configuration;
-
         let configuration = Configuration::default();
 
         let toml = toml::to_string(&configuration).expect("Could not encode TOML value");
@@ -216,8 +215,6 @@ mod tests {
 
     #[test]
     fn configuration_should_contain_the_external_ip() {
-        use crate::Configuration;
-
         let configuration = Configuration::default();
 
         assert_eq!(configuration.external_ip, Option::Some(String::from("0.0.0.0")));
@@ -229,8 +226,6 @@ mod tests {
 
         use uuid::Uuid;
 
-        use crate::Configuration;
-
         // Build temp config file path
         let temp_directory = env::temp_dir();
         let temp_file = temp_directory.join(format!("test_config_{}.toml", Uuid::new_v4()));
@@ -275,8 +270,6 @@ mod tests {
 
     #[test]
     fn configuration_should_be_loaded_from_a_toml_config_file() {
-        use crate::Configuration;
-
         let config_file_path = create_temp_config_file_with_default_config();
 
         let configuration = Configuration::load_from_file(&config_file_path).expect("Could not load configuration from file");
@@ -286,8 +279,6 @@ mod tests {
 
     #[test]
     fn configuration_error_could_be_displayed() {
-        use crate::ConfigurationError;
-
         let error = ConfigurationError::TrackerModeIncompatible;
 
         assert_eq!(format!("{}", error), "TrackerModeIncompatible");

src/config.rs

@@ -4,8 +4,9 @@ use std::sync::Arc;
 use log::{info, warn};
 use tokio::task::JoinHandle;
 
+use crate::config::HttpTrackerConfig;
 use crate::tracker::tracker::TorrentTracker;
-use crate::{HttpServer, HttpTrackerConfig};
+use crate::HttpServer;
 
 pub fn start_job(config: &HttpTrackerConfig, tracker: Arc<TorrentTracker>) -> JoinHandle<()> {
     let bind_addr = config.bind_address.parse::<SocketAddr>().unwrap();

src/jobs/http_tracker.rs

@@ -4,8 +4,8 @@ use chrono::Utc;
 use log::info;
 use tokio::task::JoinHandle;
 
+use crate::config::Configuration;
 use crate::tracker::tracker::TorrentTracker;
-use crate::Configuration;
 
 pub fn start_job(config: &Configuration, tracker: Arc<TorrentTracker>) -> JoinHandle<()> {
     let weak_tracker = std::sync::Arc::downgrade(&tracker);