feat: configurable behaviour

Author: mokurin000

Cargo.lock

@@ -7,13 +7,16 @@ description = "EcoQoS throtting tool."
 [dependencies]
 ahash = "0.8.11"
 ctrlc = "3.4.6"
+directories = "6.0.0"
 kanal = "0.1.1"
 listen-new-proc = { git = "https://github.com/RustyStarX/fitgirl-ecoqos", version = "0.1.0" }
+serde = { version = "1.0.219", features = ["derive"] }
 spdlog-rs = "0.4.2"
 tokio = { version = "1.44.2", default-features = false, features = [
     "rt-multi-thread",
     "macros",
 ] }
+toml = "0.8.22"
 win32-ecoqos = "0.5.0"
 windows = { version = "0.61", features = [
     # UI event hook

Cargo.toml

@@ -12,11 +12,11 @@ EnergyStar alernative in Rust.
 
 ## I only want to throttle blacklisted ones
 
-See [fitgirl-ecoqos](https://github.com/RustyStarX/fitgirl-ecoqos),
-a tool that forces FitGirl repack unpacker processes to run on E-cores
-(Efficiency cores) for better system resource management.
+RustyStar now supports configuration.
 
-You can customize it's blacklist. It's by default a set of decompressors.
+Locate to `%AppData%/RustyStarX/RustyStar/config` and open `config.toml`,
+
+disable `listen_foreground_events` and switch mode of `listen_new_process` to `"blacklist_only"`, configure the blacklist.
 
 ## Roadmap
 
@@ -28,11 +28,11 @@ You can customize it's blacklist. It's by default a set of decompressors.
 - [x] Event-based throttle for all new processes
 - [x] Recover processes on exit
   - [x] Ctrl-C handle
-  - [ ] windows terminate handle
+  - [ ] windows wm_close event handle
 - [x] Support UWP applications
 - [x] Support `SYSTEM` privileged processes
   > You must run `RustyStar.exe` as administrator to throttle them!
-- [ ] Configurable whitelist and blacklist
+- [x] Configurable whitelist and blacklist
 
 ## What is the efficiency mode?
 

README.md

@@ -2,7 +2,7 @@ use std::ffi::OsStr;
 
 use crate::WHITELIST;
 
-pub fn should_bypass(proc_name: impl AsRef<OsStr>) -> bool {
+pub fn whitelisted(proc_name: impl AsRef<OsStr>) -> bool {
     WHITELIST
         .get()
         .is_some_and(|bypass| bypass.contains(proc_name.as_ref()))

src/bypass/mod.rs

@@ -0,0 +1,127 @@
+use std::{error::Error, fs, path::PathBuf};
+
+use serde::{Deserialize, Serialize};
+use spdlog::warn;
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(default)]
+pub struct ListenForegroundEvents {
+    pub enabled: bool,
+}
+
+#[derive(Debug, Serialize, Deserialize, Default)]
+#[serde(rename_all = "snake_case")]
+pub enum ListenNewProcessMode {
+    #[default]
+    Normal,
+    BlacklistOnly,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(default)]
+pub struct ListenNewProcess {
+    pub enabled: bool,
+    pub mode: ListenNewProcessMode,
+    pub blacklist: Vec<String>,
+}
+
+#[derive(Debug, Serialize, Deserialize)]
+#[serde(default)]
+pub struct Config {
+    pub listen_new_process: ListenNewProcess,
+    pub listen_foreground_events: ListenForegroundEvents,
+    pub throttle_all_startup: bool,
+    pub system_process: bool,
+    pub whitelist: Vec<String>,
+}
+
+impl Config {
+    pub fn from_profile() -> Result<Self, Box<dyn Error + Send + Sync>> {
+        let config_dir = directories::ProjectDirs::from("io", "RustyStarX", "RustyStar")
+            .map(|d| d.config_dir().to_path_buf())
+            .unwrap_or(PathBuf::from("."));
+        fs::create_dir_all(&config_dir)?;
+
+        let config_path = config_dir.join("config.toml");
+        if config_path.exists() {
+            Ok(toml::from_str(&fs::read_to_string(&config_path)?)?)
+        } else {
+            warn!("config not existing! falling back to default...");
+            let config = Self::default();
+            let serialized = toml::to_string_pretty(&config)?;
+            _ = fs::write(config_path, serialized).inspect_err(|e| {
+                warn!("failed to write default config: {e}");
+            });
+            Ok(config)
+        }
+    }
+}
+
+impl Default for Config {
+    fn default() -> Self {
+        Self {
+            listen_new_process: ListenNewProcess::default(),
+            listen_foreground_events: ListenForegroundEvents::default(),
+            throttle_all_startup: true,
+            system_process: true,
+            whitelist: [
+                // ourself
+                "RustyStar.exe",
+                // System processes
+                "explorer.exe",
+                // Windows Manager of Windows
+                "dwm.exe",
+                // CSRSS core process
+                "csrss.exe",
+                // Windows services process
+                "svchost.exe",
+                // Task Manager
+                "Taskmgr.exe",
+                // Session Manager Subsystem
+                "smss.exe",
+                // Chinese input method
+                "ChsIME.exe",
+                // Speech-To-Text, Screen keyboard, handwrite input, e.g.
+                "ctfmon.exe",
+                // Windows User Mode Driver Framework
+                "WUDFRd.exe",
+                "WUDFHost.exe",
+                // Edge is energy aware
+                "msedge.exe",
+                // UWP special handle
+                "ApplicationFrameHost.exe",
+                // system itself
+                "[System Process]",
+                "System",
+                "Registry",
+                // parent of "services.exe"
+                "wininit.exe",
+                // parent of "svchost.exe", "wudfhost.exe", e.g.
+                "services.exe",
+                // Local Security Authority Subsystem Service
+                "lsass.exe",
+                // part of the Windows Security Center,
+                // responsible for monitoring and reporting the security status of your system
+                "SecurityHealthService.exe",
+            ]
+            .map(str::to_string)
+            .to_vec(),
+        }
+    }
+}
+
+impl Default for ListenForegroundEvents {
+    fn default() -> Self {
+        Self { enabled: true }
+    }
+}
+
+impl Default for ListenNewProcess {
+    fn default() -> Self {
+        Self {
+            enabled: true,
+            mode: ListenNewProcessMode::default(),
+            blacklist: vec![],
+        }
+    }
+}

src/config/mod.rs

@@ -4,6 +4,7 @@ use ahash::AHashSet;
 use kanal::Sender;
 
 pub mod bypass;
+pub mod config;
 pub mod events;
 pub mod logging;
 pub mod privilege;