1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
use std::collections::HashMap;
use std::fs;
use std::path::{Path, PathBuf};
use regex::Regex;
use serde::{Deserialize, Serialize};
use walkdir::WalkDir;
use crate::constant;
use crate::squire::authenticator;
use crate::squire::settings;
/// Represents the payload structure for content, including files and directories.
///
/// This struct is used for serialization and deserialization, providing default values
/// when necessary.
#[derive(Debug, Serialize, Deserialize, Default)]
pub struct ContentPayload {
/// List of files with their names, paths and font icons.
#[serde(default = "default_structure")]
pub files: Vec<HashMap<String, String>>,
/// List of directories with their names, paths and font icons.
#[serde(default = "default_structure")]
pub directories: Vec<HashMap<String, String>>,
/// List of user specific directories with their names, paths and font icons.
#[serde(default = "default_structure")]
pub secured_directories: Vec<HashMap<String, String>>,
}
/// Returns the default structure for content, represented as an empty vector of HashMaps.
pub fn default_structure() -> Vec<HashMap<String, String>> {
Vec::new()
}
/// Extracts a natural sort key from a filename.
///
/// This function takes a filename as input and splits it into a list of parts using a regular expression.
/// It then converts numeric parts to integers while keeping non-numeric parts as lowercase strings.
/// This enables a natural sorting order that considers both alphabetical and numerical components of filenames,
/// making it suitable for sorting filenames in a human-friendly manner.
///
/// # Arguments
///
/// * `regex` - Pre-compiled regex object.
/// * `filename` - A string representing the filename.
///
/// # Returns
///
/// A vector of `Result<i32, String>` where each element is either an integer representing a numeric part
/// or a string representing a non-numeric part converted to lowercase.
fn natural_sort_key(regex: &Regex, filename: &str) -> Vec<Result<i32, String>> {
// reusing regex is way faster than creating a new object everytime (~8s
regex.find_iter(filename)
.map(|part| {
// chaining methods is kinda faster (~79% faster in terms of ms)
part.as_str().parse::<i32>().map_err(|e| e.to_string())
// if let Ok(num) = part.as_str().parse::<i32>() {
// Ok(num)
// } else {
// Err(part.as_str().to_string())
// }
})
.collect()
}
/// Generate font awesome icon's value for a given file extension.
///
/// Creates custom icons for `image` files, defaults to `video` icon.
///
/// # Arguments
///
/// * `extn` - File extension.
///
/// # Returns
///
/// A string with the `fa` value based on the file extension.
pub fn get_file_font(extn: &str) -> String {
let font = if constant::IMAGE_FORMATS.contains(&extn) {
"fa-regular fa-file-image"
} else {
"fa-regular fa-file-video"
};
font.to_string()
}
/// Generate font awesome icon's value for a given folder depth.
///
/// Creates custom icons for `folder-tree`, defaults to `folder` icon.
///
/// # Arguments
///
/// * `tree` - Depth of directories.
///
/// # Returns
///
/// A string with the `fa` value based on the folder depth.
fn get_folder_font(structure: &Path,
auth_response: &authenticator::AuthToken) -> HashMap<String, String> {
let directory = structure.to_string_lossy().to_string();
let mut entry_map = HashMap::new();
entry_map.insert("path".to_string(), format!("stream/{}", &directory));
let depth = &structure.iter().count();
for component in structure.iter() {
let secured = format!("{}_{}", &auth_response.username, constant::SECURE_INDEX);
if secured == component.to_string_lossy() {
entry_map.insert("name".to_string(), directory);
entry_map.insert("font".to_string(), "fa-solid fa-lock".to_string());
entry_map.insert("secured".to_string(), "true".to_string());
return entry_map;
} else if component.to_string_lossy().ends_with(constant::SECURE_INDEX) {
// If the path has secure index value (includes folder trees / subdirectories)
return HashMap::new();
}
}
entry_map.insert("name".to_string(), directory);
if *depth > 1 {
entry_map.insert("font".to_string(), "fa-solid fa-folder-tree".to_string());
} else {
entry_map.insert("font".to_string(), "fa fa-folder".to_string());
}
entry_map
}
/// Retrieves content information for all streams.
///
/// # Arguments
///
/// * `config` - Configuration data for the application.
///
/// # Returns
///
/// A `ContentPayload` struct representing the content of all streams.
pub fn get_all_stream_content(config: &settings::Config, auth_response: &authenticator::AuthToken) -> ContentPayload {
let mut payload = ContentPayload::default();
for entry in WalkDir::new(&config.media_source).into_iter().filter_map(|e| e.ok()) {
if entry.path().ends_with("__") {
continue;
}
if let Some(file_name) = entry.file_name().to_str() {
if file_name.starts_with('_') || file_name.starts_with('.') {
continue;
}
if let Some(extension) = PathBuf::from(file_name).extension().and_then(|ext| ext.to_str()) {
if config.file_formats.iter().any(|format| extension == format) {
let path = entry.path().strip_prefix(&config.media_source)
.unwrap_or_else(|_| Path::new(""));
let components: &Vec<_> = &path.components().collect();
if components.len() == 1 {
let mut entry_map = HashMap::new();
entry_map.insert("path".to_string(), format!("stream/{}", &file_name));
entry_map.insert("name".to_string(), file_name.to_string());
entry_map.insert("font".to_string(), get_file_font(extension));
payload.files.push(entry_map);
} else {
/*
path.components(): returns an iterator over the components of the path
.rev(): reverses the order of the iterator
.skip(1): skips the first (originally last) component of the reversed path
*/
let skimmed = path.components().rev().skip(1)
.collect::<Vec<_>>().iter().rev()
.collect::<PathBuf>();
let entry_map = get_folder_font(&skimmed, auth_response);
if entry_map.get("secured").unwrap_or(&"".to_string()) == "true" {
if payload.secured_directories.contains(&entry_map) || entry_map.is_empty() { continue; }
payload.secured_directories.push(entry_map);
} else {
if payload.directories.contains(&entry_map) || entry_map.is_empty() { continue; }
payload.directories.push(entry_map);
}
}
}
}
}
}
let re = Regex::new(r"(\D+|\d+)").unwrap();
payload.files.sort_by(|a, b| natural_sort_key(&re, &a["name"]).cmp(&natural_sort_key(&re, &b["name"])));
payload.directories.sort_by(|a, b| natural_sort_key(&re, &a["name"]).cmp(&natural_sort_key(&re, &b["name"])));
payload
}
/// Retrieves content information for a specific directory within a stream.
///
/// # Arguments
///
/// * `parent` - Path to the parent directory.
/// * `child` - Path to the child directory.
/// * `file_formats` - File formats (set as env vars) that are allowed for streaming.
///
/// # Returns
///
/// A `ContentPayload` struct representing the content of the specified directory.
pub fn get_dir_stream_content(parent: &str,
child: &str,
file_formats: &[String]) -> ContentPayload {
let mut files = Vec::new();
for entry in fs::read_dir(parent).unwrap().flatten() {
let file_name = entry.file_name().into_string().unwrap();
if file_name.starts_with('_') || file_name.starts_with('.') {
continue;
}
let file_path = Path::new(child).join(&file_name);
let file_extn = &file_path.extension().unwrap_or_default().to_string_lossy().to_string();
if file_formats.contains(file_extn) {
let map = HashMap::from([
("name".to_string(), file_name),
("path".to_string(), file_path.to_string_lossy().to_string()),
("font".to_string(), get_file_font(file_extn))
]);
files.push(map);
}
}
let re = Regex::new(r"(\D+|\d+)").unwrap();
files.sort_by_key(|a| natural_sort_key(&re, a.get("name").unwrap()));
ContentPayload { files, ..Default::default() }
}
/// Represents an iterator structure with optional previous and next elements.
#[derive(Debug, Serialize, Deserialize, Default)]
pub struct Iter {
/// Optional previous element in the iteration.
pub previous: Option<String>,
/// Optional next element in the iteration.
pub next: Option<String>,
}
/// Retrieves the previous and/or next file to the currently streaming file.
///
/// # Arguments
///
/// * `filepath` - File that is requested for streaming.
/// * `file_formats` - Vector of file formats (as String) that are allowed.
///
/// # Returns
///
/// An `Iter` struct representing the iterator information.
pub fn get_iter(filepath: &Path, file_formats: &[String]) -> Iter {
let parent = filepath.parent().unwrap();
let mut dir_content: Vec<String> = fs::read_dir(parent)
.ok().unwrap()
.flatten()
.filter_map(|entry| {
let file_name = entry.file_name().to_string_lossy().to_string();
let file_extn = Path::new(&file_name).extension().unwrap_or_default().to_string_lossy().to_string();
if file_formats.contains(&file_extn) {
Some(file_name)
} else {
None
}
})
.collect();
let re = Regex::new(r"(\D+|\d+)").unwrap();
dir_content.sort_by_key(|a| natural_sort_key(&re, a));
let idx = dir_content.iter().position(|file| file == filepath.file_name().unwrap().to_str().unwrap()).unwrap();
let previous_ = if idx > 0 {
let previous_ = &dir_content[idx - 1];
if previous_ == filepath.file_name().unwrap().to_str().unwrap() {
None
} else {
Some(previous_.clone())
}
} else {
None
};
let next_ = dir_content.get(idx + 1).cloned();
Iter { previous: previous_, next: next_ }
}