move settings into dedicated config file

Author: rkusa

CHANGELOG.md

@@ -6,13 +6,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-## [3.0.0-beta.1] - 2021-04-20
+## [3.0.0-beta.2] - 2021-04-20
+
+### Removed
 
-BREAKING: Requires DCS 2.7 from now on.
+- **BREAKING:** The plugin settings have been removed from the DCS settings screen. DATIS is now configured through a config file at `Saved Games\DCS.openbeta\Config\DATIS.json`, see [Settings](./docs/Settings.md). Existing settings are not automatically migrated. This has been done, because each mission you save contains all your plugin settings. This included the cloud provider access keys set for DATIS. The change has been made to prevent the accidential sharing of those credentials.
+
+## [3.0.0-beta.1] - 2021-04-20
 
 ### Added
 
-- Added support for DCS 2.7 cloud presets.
+- **BREAKING:** Added support for DCS 2.7 cloud presets. Requires DCS 2.7 from now on.
 
 ## [2.2.2] - 2021-04-11
 

README.md

@@ -23,49 +23,27 @@ ATIS stations are not the only report kind this mod supports, all supported repo
 
 The mods uses the Window' built-in TTS by default, but can also either use Google Cloud's TTS, AWS Polly, or a combination of all of them (tip: setup both Google Cloud and Amazon Web Services to have a greater choice of different voices).
 
+## Migrate to 3.x.x
+
+The plugin settings have been removed from the DCS settings screen. DATIS is now configured through a config file at `Saved Games\DCS.openbeta\Config\DATIS.json`, see [Settings](./docs/Settings.md).
+This has been done, because each mission you save contains all your plugin settings. This included the cloud provider access keys set for DATIS. The change has been made to prevent the accidential sharing of those credentials.
+
 ## Installation
 
 [Build it](#build) yourself and use the content inside the `mod` directory or use the pre-build mod from one of the [releases](https://github.com/rkusa/DATIS/releases).
 
 1. Copy the content (`Mods` and `Scripts` directory) into `Saved Games\DCS.openbeta\`.
-2. Optional (not necessary when using Window' built-in TTS): Setup your cloud provider of choice
-   1. Create your cloud credentials, either
-      1. Google Cloud: Go to https://console.cloud.google.com/apis/credentials and create an API key and restrict API access to Google Text-to-Speech, or
-      2. Amazon Web Services: Go to https://console.aws.amazon.com/iam/home#/users and create a new user with `AmazonPollyReadOnlyAccess` permissions
-   2. Open DCS go to OPTIONS -> SPECIAL -> DCS ATIS, enter your API keys into the respective input fields
+2. Optional: Customize your settings, see [Settings](./docs/Settings.md)
 
 Once you start a mission that contains a pattern as described in the next section, DATIS runs automatically.
-It thereby expects a SRS server to run locally on the default SRS ports. The port can be changed in the DCS DATIS mod settings page.
+It thereby expects a SRS server to run locally on the default SRS ports.
 
 If DATIS isn't working, you might find some helpful information in the log file at `DCS.openbeta\Logs\DATIS.log`.
 
 For information about the free tier of both GCloud and AWS see:
 - https://cloud.google.com/text-to-speech/pricing
 - https://aws.amazon.com/polly/pricing/
 
-![Settings](./docs/settings.jpg)
-
-While it is easiest to temporariely start DCS with a GUI even on a dedicated server for the sake of changing DATIS settings, they can also be changed by manually updating `Saved Games\DCS.openbeta\Config\options.lua`:
-
-```lua
-options = {
-	-- ...
-	["plugins"] = {
-		-- ..
-		["DATIS"] = {
-			["awsAccessKey"] = "Your AWS access key",
-			["awsPrivateKey"] = "Your AWS private key",
-			["awsRegion"] = "eu-central-1",
-			["debugLoggingEnabled"] = false,
-			["defaultVoice"] = "WIN",
-			["gcloudAccessKey"] = "Your Google Cloud access key",
-			["srsPort"] = "5002",
-		},
-		-- ..
-	}
-}
-```
-
 ## Setup
 
 ### Setup ATIS stations

crates/datis-cmd/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "datis-cmd"
-version = "3.0.0-beta.1"
+version = "3.0.0-beta.2"
 authors = ["Markus Ast <m@rkusa.st>"]
 edition = "2018"
 

crates/datis-cmd/src/main.rs

@@ -1,6 +1,7 @@
 use std::str::FromStr;
 
 use clap::{App, Arg};
+use datis_core::config::{AwsConfig, GcloudConfig};
 use datis_core::station::{Airfield, Position, Station, Transmitter};
 use datis_core::tts::TextToSpeechProvider;
 use datis_core::Datis;
@@ -90,21 +91,27 @@ pub fn main() -> Result<(), Box<dyn std::error::Error>> {
             active_rwy_override: None,
         }),
     };
-    let mut datis = Datis::new(vec![station])?;
-    datis.set_port(5002);
+    let mut config = Default::default();
 
     if let Some(key) = matches.value_of("gcloud_key") {
-        datis.set_gcloud_key(key);
+        config.gcloud = Some(GcloudConfig {
+            key: key.to_string(),
+        })
     }
 
     if let (Some(key), Some(secret), Some(region)) = (
         matches.value_of("aws_key"),
         matches.value_of("aws_secret"),
         matches.value_of("aws_region"),
     ) {
-        datis.set_aws_keys(key, secret, region);
+        config.aws = Some(AwsConfig {
+            key: key.to_string(),
+            secret: secret.to_string(),
+            region: region.to_string(),
+        })
     }
 
+    let datis = Datis::new(vec![station], config)?;
     datis.start()?;
 
     let (tx, rx) = std::sync::mpsc::channel();

crates/datis-core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "datis-core"
-version = "3.0.0-beta.1"
+version = "3.0.0-beta.2"
 authors = ["Markus Ast <m@rkusa.st>"]
 edition = "2018"
 

crates/datis-core/src/config.rs

@@ -0,0 +1,42 @@
+use crate::tts::TextToSpeechProvider;
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct Config {
+    #[serde(default)]
+    pub default_voice: TextToSpeechProvider,
+    pub gcloud: Option<GcloudConfig>,
+    pub aws: Option<AwsConfig>,
+    #[serde(default = "default_srs_port")]
+    pub srs_port: u16,
+    #[serde(default)]
+    pub debug: bool,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct GcloudConfig {
+    pub key: String,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct AwsConfig {
+    pub key: String,
+    pub secret: String,
+    pub region: String,
+}
+
+impl Default for Config {
+    fn default() -> Self {
+        Config {
+            default_voice: TextToSpeechProvider::default(),
+            gcloud: None,
+            aws: None,
+            srs_port: default_srs_port(),
+            debug: false,
+        }
+    }
+}
+
+fn default_srs_port() -> u16 {
+    5002
+}

crates/datis-core/src/export.rs

@@ -1,5 +1,6 @@
 use std::collections::HashMap;
 use std::fs::File;
+use std::path::{Path, PathBuf};
 use std::sync::Arc;
 use std::{error, fmt};
 
@@ -9,14 +10,14 @@ use futures::lock::Mutex;
 pub struct ReportExporter(Arc<Mutex<ReportExporterInner>>);
 
 pub struct ReportExporterInner {
-    path: String,
+    path: PathBuf,
     reports: HashMap<String, String>,
 }
 
 impl ReportExporter {
-    pub fn new(path: String) -> Self {
+    pub fn new(path: impl AsRef<Path>) -> Self {
         ReportExporter(Arc::new(Mutex::new(ReportExporterInner {
-            path,
+            path: path.as_ref().to_path_buf(),
             reports: HashMap::new(),
         })))
     }

crates/datis-core/src/lib.rs

@@ -1,6 +1,7 @@
 #[macro_use]
 extern crate anyhow;
 
+pub mod config;
 pub mod export;
 pub mod extract;
 #[cfg(feature = "ipc")]
@@ -12,6 +13,7 @@ pub mod weather;
 
 use std::mem;
 use std::net::{IpAddr, Ipv4Addr, SocketAddr};
+use std::path::Path;
 use std::str::FromStr;
 use std::sync::Arc;
 use std::time::{Duration, Instant};
@@ -24,6 +26,7 @@ use crate::tts::{
     win::{self, WindowsConfig},
     TextToSpeechConfig, TextToSpeechProvider,
 };
+use config::{AwsConfig, Config};
 use futures::future::FutureExt;
 use futures::select;
 use futures::sink::SinkExt;
@@ -36,57 +39,27 @@ use tokio::time::sleep;
 pub struct Datis {
     stations: Vec<Station>,
     exporter: Option<ReportExporter>,
-    gcloud_key: Option<String>,
-    aws_config: Option<AwsConfig>,
-    port: u16,
+    config: Config,
     runtime: Runtime,
     started: bool,
     shutdown_signals: Vec<oneshot::Sender<()>>,
 }
 
-struct AwsConfig {
-    key: String,
-    secret: String,
-    region: String,
-}
-
 impl Datis {
-    pub fn new(stations: Vec<Station>) -> Result<Self, Error> {
+    pub fn new(stations: Vec<Station>, config: Config) -> Result<Self, Error> {
         Ok(Datis {
             stations,
             exporter: None,
-            gcloud_key: None,
-            aws_config: None,
-            port: 5002,
+            config,
             runtime: runtime::Builder::new_multi_thread().enable_all().build()?,
             started: false,
             shutdown_signals: Vec::new(),
         })
     }
 
-    pub fn set_port(&mut self, port: u16) {
-        self.port = port;
-    }
-
-    pub fn set_gcloud_key<S: Into<String>>(&mut self, key: S) {
-        self.gcloud_key = Some(key.into());
-    }
-
-    pub fn set_aws_keys<K: Into<String>, S: Into<String>, R: Into<String>>(
-        &mut self,
-        key: K,
-        secret: S,
-        region: R,
-    ) {
-        self.aws_config = Some(AwsConfig {
-            key: key.into(),
-            secret: secret.into(),
-            region: region.into(),
-        });
-    }
-
-    pub fn set_log_dir<S: Into<String>>(&mut self, log_dir: S) {
-        let exporter = ReportExporter::new(log_dir.into() + "atis-reports.json");
+    pub fn enable_exporter(&mut self, write_dir: impl AsRef<Path>) {
+        let path = write_dir.as_ref().to_path_buf().join("atis-reports.json");
+        let exporter = ReportExporter::new(path);
         self.exporter = Some(exporter);
     }
 
@@ -100,9 +73,9 @@ impl Datis {
         for station in &mut self.stations {
             let config = match station.tts {
                 TextToSpeechProvider::GoogleCloud { voice } => {
-                    if let Some(ref key) = self.gcloud_key {
+                    if let Some(ref config) = self.config.gcloud {
                         TextToSpeechConfig::GoogleCloud(GoogleCloudConfig {
-                            key: key.clone(),
+                            key: config.key.clone(),
                             voice,
                         })
                     } else {
@@ -118,7 +91,7 @@ impl Datis {
                         ref key,
                         ref secret,
                         ref region,
-                    }) = self.aws_config
+                    }) = self.config.aws
                     {
                         TextToSpeechConfig::AmazonWebServices(AmazonWebServicesConfig {
                             key: key.clone(),
@@ -157,7 +130,7 @@ impl Datis {
             self.runtime.spawn(
                 spawn(
                     station.clone(),
-                    self.port,
+                    self.config.srs_port,
                     config,
                     self.exporter.clone(),
                     rx,

crates/datis-core/src/tts/aws.rs

@@ -1,3 +1,4 @@
+use std::fmt::Display;
 use std::str::FromStr;
 
 use audiopus::{coder::Encoder, Application, Channels, SampleRate};
@@ -109,8 +110,8 @@ impl FromStr for VoiceKind {
     }
 }
 
-impl ToString for VoiceKind {
-    fn to_string(&self) -> String {
-        format!("{:?}", self)
+impl Display for VoiceKind {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{:?}", self)
     }
 }

crates/datis-core/src/tts/gcloud.rs

@@ -1,3 +1,4 @@
+use std::fmt::Display;
 use std::io::Cursor;
 use std::str::FromStr;
 
@@ -188,3 +189,9 @@ impl FromStr for VoiceKind {
         serde_json::from_value(json!(s))
     }
 }
+
+impl Display for VoiceKind {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        f.write_str(&serde_json::to_string(self).unwrap())
+    }
+}