ryze/ff2mpv-rust
1
0
Fork 0
Code Issues Pull requests Releases 8 Activity

Clean up config.rs

Browse source 
Some refactoring to `config.rs` with the aim to:

* Increase type safety
* Reduce duplication
* Leverage `std::result::Result` & `std::path::PathBuf` APIs

To achieve these goals, the following was done:

* `get_config_file` propagates an `FF2MpvError` if the config file doesn't exist/is invalid
* Always type check `unix` & `windows` code by using `cfg!` expressions over
`#[cfg()]` attributes. This also removed some duplicated lines of code
* Move `#[serde(default)]` to `Config` struct instead of every struct
member: https://serde.rs/container-attrs.html#default
This commit is contained in:
Markus Pettersson 2023-10-29 19:06:52 +01:00
parent 4fcc2ac31f
commit ef7e431779
1 changed files with 33 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

80
src/config.rs
View file

@ -1,81 +1,67 @@
use serde::Deserialize;
use std::env;
use std::fs;
use std::path::PathBuf;
use serde::Deserialize;
use crate::error::FF2MpvError;
#[derive(Deserialize)]
#[serde(default)]
pub struct Config {
#[serde(default = "default_player_command")]
pub player_command: String,
#[serde(default = "default_player_args")]
pub player_args: Vec<String>,
}
impl Default for Config {
fn default() -> Self {
Self {
player_command: default_player_command(),
player_args: default_player_args(),
player_command: "mpv".to_owned(),
player_args: vec![],
}
}
}
impl Config {
pub const FILENAME: &str = "ff2mpv-rust.json";
pub fn build() -> Self {
if let Ok(config) = Config::parse_config_file() {
config
} else {
Config::default()
}
Config::parse_config_file().unwrap_or_default()
}
pub fn parse_config_file() -> Result<Self, FF2MpvError> {
let config_path = Config::get_config_location();
if !config_path.exists() {
return Err(FF2MpvError::NoConfig);
}
let config_path = Config::get_config_location()?;
let string = fs::read_to_string(config_path)?;
let config = serde_json::from_str(&string)?;
Ok(config)
}
#[cfg(target_family = "unix")]
fn get_config_location() -> PathBuf {
let mut path = PathBuf::new();
if let Ok(home) = env::var("XDG_CONFIG_HOME") {
path.push(home);
} else if let Ok(home) = env::var("HOME") {
path.push(home);
path.push(".config");
/// Returns a *valid* config path, i.e. it exists and is readable by the
/// current user. If the config path is not valid, an [`FF2MpvError`] is
/// returned.
fn get_config_location() -> Result<PathBuf, FF2MpvError> {
let config_dir = if cfg!(target_family = "unix") {
if let Ok(home) = env::var("XDG_CONFIG_HOME") {
PathBuf::from(home)
} else if let Ok(home) = env::var("HOME") {
PathBuf::from(home).join(".config")
} else {
PathBuf::from("/etc")
}
} else if cfg!(target_family = "windows") {
env::var("APPDATA")
.map_err(|_| FF2MpvError::NoConfig)?
.into()
} else {
path.push("/etc");
unimplemented!("This platform is not supported")
};
let path = config_dir.join(Config::FILENAME);
match path.try_exists() {
Ok(true) => Ok(path),
// Broken symbolic link to config file.
Ok(false) => Err(FF2MpvError::NoConfig),
Err(err) => Err(FF2MpvError::IOError(err)),
}
path.push("ff2mpv-rust.json");
path
}
#[cfg(target_family = "windows")]
fn get_config_location() -> PathBuf {
let mut path = PathBuf::new();
let appdata = env::var("APPDATA").unwrap();
path.push(appdata);
path.push("ff2mpv-rust.json");
path
}
}
fn default_player_command() -> String {
"mpv".to_owned()
}
fn default_player_args() -> Vec<String> {
vec![]
}