From fda6c3a9be3394a1457962182a8343697a4591f0 Mon Sep 17 00:00:00 2001 From: neon_arch Date: Tue, 22 Aug 2023 19:18:43 +0300 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20feat:=20rename=20public=5Fpaths=20t?= =?UTF-8?q?o=20paths=20(#163)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/handler/mod.rs | 2 +- src/handler/paths.rs | 111 ++++++++++++++++++++++++++++++++++++ src/handler/public_paths.rs | 33 ----------- 3 files changed, 112 insertions(+), 34 deletions(-) create mode 100644 src/handler/paths.rs delete mode 100644 src/handler/public_paths.rs diff --git a/src/handler/mod.rs b/src/handler/mod.rs index 0d07e51..8118b29 100644 --- a/src/handler/mod.rs +++ b/src/handler/mod.rs @@ -1 +1 @@ -pub mod public_paths; +pub mod paths; diff --git a/src/handler/paths.rs b/src/handler/paths.rs new file mode 100644 index 0000000..9b4fa07 --- /dev/null +++ b/src/handler/paths.rs @@ -0,0 +1,111 @@ +//! This module provides the functionality to handle theme folder present on different paths and +//! provide one appropriate path on which it is present and can be used. + +use std::collections::HashMap; +use std::io::Error; +use std::path::Path; + +// ------- Constants -------- +static PUBLIC_DIRECTORY_NAME: &str = "public"; +static COMMON_DIRECTORY_NAME: &str = "websurfx"; +static CONFIG_FILE_NAME: &str = "config.lua"; +static ALLOWLIST_FILE_NAME: &str = "allowlist.txt"; +static BLOCKLIST_FILE_NAME: &str = "blocklist.txt"; + +#[derive(Hash, PartialEq, Eq, Debug)] +pub enum FileType { + Config, + AllowList, + BlockList, + Theme, +} + +static FILE_PATHS_FOR_DIFF_FILE_TYPES: once_cell::sync::Lazy>> = + once_cell::sync::Lazy::new(|| { + HashMap::from([ + ( + FileType::Config, + vec![ + format!( + "{}/.config/{}/{}", + std::env::var("HOME").unwrap(), + COMMON_DIRECTORY_NAME, + CONFIG_FILE_NAME + ), + format!("/etc/xdg/{}/{}", COMMON_DIRECTORY_NAME, CONFIG_FILE_NAME), + format!("./{}/{}", COMMON_DIRECTORY_NAME, CONFIG_FILE_NAME), + ], + ), + ( + FileType::Theme, + vec![ + format!("/opt/websurfx/{}/", PUBLIC_DIRECTORY_NAME), + format!("./{}/", PUBLIC_DIRECTORY_NAME), + ], + ), + ( + FileType::AllowList, + vec![ + format!( + "{}/.config/{}/{}", + std::env::var("HOME").unwrap(), + COMMON_DIRECTORY_NAME, + ALLOWLIST_FILE_NAME + ), + format!("/etc/xdg/{}/{}", COMMON_DIRECTORY_NAME, ALLOWLIST_FILE_NAME), + format!("./{}/{}", COMMON_DIRECTORY_NAME, ALLOWLIST_FILE_NAME), + ], + ), + ( + FileType::BlockList, + vec![ + format!( + "{}/.config/{}/{}", + std::env::var("HOME").unwrap(), + COMMON_DIRECTORY_NAME, + BLOCKLIST_FILE_NAME + ), + format!("/etc/xdg/{}/{}", COMMON_DIRECTORY_NAME, BLOCKLIST_FILE_NAME), + format!("./{}/{}", COMMON_DIRECTORY_NAME, BLOCKLIST_FILE_NAME), + ], + ), + ]) + }); + +/// A helper function which returns an appropriate config file path checking if the config +/// file exists on that path. +/// +/// # Error +/// +/// Returns a `config file not found!!` error if the config file is not present under following +/// paths which are: +/// 1. `~/.config/websurfx/` if it not present here then it fallbacks to the next one (2) +/// 2. `/etc/xdg/websurfx/config.lua` if it is not present here then it fallbacks to the next +/// one (3). +/// 3. `websurfx/` (under project folder ( or codebase in other words)) if it is not present +/// here then it returns an error as mentioned above. + +/// A function which returns an appropriate theme directory path checking if the theme +/// directory exists on that path. +/// +/// # Error +/// +/// Returns a `Theme (public) folder not found!!` error if the theme folder is not present under following +/// paths which are: +/// 1. `/opt/websurfx` if it not present here then it fallbacks to the next one (2) +/// 2. Under project folder ( or codebase in other words) if it is not present +/// here then it returns an error as mentioned above. +pub fn file_path(file_type: FileType) -> Result { + let file_path = FILE_PATHS_FOR_DIFF_FILE_TYPES.get(&file_type).unwrap(); + for (idx, _) in file_path.iter().enumerate() { + if Path::new(file_path[idx].as_str()).exists() { + return Ok(file_path[idx].clone()); + } + } + + // if no of the configs above exist, return error + Err(Error::new( + std::io::ErrorKind::NotFound, + format!("{:?} file not found!!", file_type), + )) +} diff --git a/src/handler/public_paths.rs b/src/handler/public_paths.rs deleted file mode 100644 index 18d51e4..0000000 --- a/src/handler/public_paths.rs +++ /dev/null @@ -1,33 +0,0 @@ -//! This module provides the functionality to handle theme folder present on different paths and -//! provide one appropriate path on which it is present and can be used. - -use std::io::Error; -use std::path::Path; - -// ------- Constants -------- -static PUBLIC_DIRECTORY_NAME: &str = "public"; - -/// A function which returns an appropriate theme directory path checking if the theme -/// directory exists on that path. -/// -/// # Error -/// -/// Returns a `Theme (public) folder not found!!` error if the theme folder is not present under following -/// paths which are: -/// 1. `/opt/websurfx` if it not present here then it fallbacks to the next one (2) -/// 2. Under project folder ( or codebase in other words) if it is not present -/// here then it returns an error as mentioned above. -pub fn public_path() -> Result { - if Path::new(format!("/opt/websurfx/{}/", PUBLIC_DIRECTORY_NAME).as_str()).exists() { - return Ok(format!("/opt/websurfx/{}", PUBLIC_DIRECTORY_NAME)); - } - - if Path::new(format!("./{}/", PUBLIC_DIRECTORY_NAME).as_str()).exists() { - return Ok(format!("./{}", PUBLIC_DIRECTORY_NAME)); - } - - Err(Error::new( - std::io::ErrorKind::NotFound, - "Themes (public) folder not found!!", - )) -}