mirror of
https://github.com/nimbold/Firelink.git
synced 2026-08-07 01:44:01 +00:00
feat(torrent): add standalone properties windows
- add caller-bound native properties bridge and lifecycle guards - split Network settings into accessible secondary tabs - add tabbed Torrent and generic Properties surfaces - harden runtime validation and ignore the implementation plan
This commit is contained in:
NimBold
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"$schema": "../gen/schemas/desktop-schema.json",
|
||||
"identifier": "properties-window",
|
||||
"description": "Minimal capability for Firelink Properties windows",
|
||||
"windows": ["properties-*"],
|
||||
"permissions": [
|
||||
"core:window:allow-close",
|
||||
"core:window:allow-set-title",
|
||||
"core:event:allow-listen",
|
||||
"core:event:allow-unlisten",
|
||||
"dialog:default",
|
||||
"clipboard-manager:allow-write-text",
|
||||
"log:default"
|
||||
]
|
||||
}
|
||||
@@ -4,9 +4,11 @@ use tauri_plugin_opener::OpenerExt;
|
||||
|
||||
#[tauri::command]
|
||||
pub async fn reveal_in_file_manager(
|
||||
caller: tauri::WebviewWindow,
|
||||
app_handle: tauri::AppHandle,
|
||||
path: String,
|
||||
) -> Result<(), String> {
|
||||
crate::properties_window::ensure_main_window(&caller)?;
|
||||
let primary = authorize_reveal_path(&app_handle, &path)?;
|
||||
let path = existing_download_asset(&primary).ok_or_else(|| {
|
||||
format!(
|
||||
@@ -29,9 +31,11 @@ pub async fn reveal_in_file_manager(
|
||||
|
||||
#[tauri::command]
|
||||
pub async fn open_downloaded_file(
|
||||
caller: tauri::WebviewWindow,
|
||||
app_handle: tauri::AppHandle,
|
||||
path: String,
|
||||
) -> Result<(), String> {
|
||||
crate::properties_window::ensure_main_window(&caller)?;
|
||||
let path = authorize_download_path(&app_handle, &path)?;
|
||||
if !path.exists() {
|
||||
return Err(format!("Downloaded file is missing: {}", path.display()));
|
||||
|
||||
+288
-29
File diff suppressed because it is too large
Load Diff
@@ -6,7 +6,8 @@ use ts_rs::TS;
|
||||
use crate::ipc::DownloadCategory;
|
||||
|
||||
#[tauri::command]
|
||||
pub async fn get_system_proxy() -> Result<Option<String>, String> {
|
||||
pub async fn get_system_proxy(caller: tauri::WebviewWindow) -> Result<Option<String>, String> {
|
||||
crate::properties_window::ensure_main_window(&caller)?;
|
||||
match native_system_proxy() {
|
||||
Ok(Some(proxy)) => Ok(Some(proxy)),
|
||||
Ok(None) => Ok(proxy_from_environment()),
|
||||
@@ -539,8 +540,10 @@ struct GitHubRelease {
|
||||
|
||||
#[tauri::command]
|
||||
pub async fn check_for_updates(
|
||||
caller: tauri::WebviewWindow,
|
||||
app_handle: tauri::AppHandle,
|
||||
) -> Result<ReleaseCheckOutcome, String> {
|
||||
crate::properties_window::ensure_main_window(&caller)?;
|
||||
let current_version = app_handle.package_info().version.to_string();
|
||||
|
||||
crate::ensure_reqwest_crypto_provider();
|
||||
@@ -606,10 +609,12 @@ fn cmp_versions(a: &str, b: &str) -> std::cmp::Ordering {
|
||||
|
||||
#[tauri::command]
|
||||
pub async fn create_category_directories(
|
||||
caller: tauri::WebviewWindow,
|
||||
app_handle: tauri::AppHandle,
|
||||
base_folder: String,
|
||||
subfolders: std::collections::HashMap<String, String>,
|
||||
) -> Result<(), String> {
|
||||
crate::properties_window::ensure_main_window(&caller)?;
|
||||
let base = crate::resolve_path(&base_folder, &app_handle);
|
||||
let mut errors = Vec::new();
|
||||
|
||||
|
||||
@@ -0,0 +1,392 @@
|
||||
use std::collections::HashMap;
|
||||
use std::sync::Mutex;
|
||||
|
||||
use serde::Serialize;
|
||||
use tauri::{Emitter, Manager, WebviewUrl, WebviewWindowBuilder};
|
||||
use uuid::Uuid;
|
||||
|
||||
const MAIN_WINDOW_LABEL: &str = "main";
|
||||
const PROPERTIES_LABEL_PREFIX: &str = "properties-";
|
||||
const PROPERTIES_WINDOW_TITLE: &str = "Properties - Firelink";
|
||||
const PROPERTIES_WINDOW_READY_EVENT: &str = "properties-window-ready";
|
||||
const PROPERTIES_WINDOW_ACTION_REQUEST_EVENT: &str = "properties-window-action-request";
|
||||
const MAX_PROPERTIES_ACTION_PAYLOAD_BYTES: usize = 64 * 1024;
|
||||
|
||||
#[derive(Default)]
|
||||
pub struct PropertiesWindowRegistry {
|
||||
state: Mutex<RegistryState>,
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
struct RegistryState {
|
||||
by_download: HashMap<String, String>,
|
||||
by_window: HashMap<String, String>,
|
||||
}
|
||||
|
||||
#[derive(Clone, Serialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct PropertiesWindowReadyEvent {
|
||||
window_label: String,
|
||||
download_id: String,
|
||||
}
|
||||
|
||||
#[derive(Clone, Serialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct PropertiesWindowActionEvent {
|
||||
window_label: String,
|
||||
download_id: String,
|
||||
request_id: u64,
|
||||
action: String,
|
||||
payload: Option<serde_json::Value>,
|
||||
}
|
||||
|
||||
impl PropertiesWindowRegistry {
|
||||
pub fn allocate(&self, download_id: &str) -> Result<String, String> {
|
||||
let mut state = self
|
||||
.state
|
||||
.lock()
|
||||
.map_err(|_| "Properties window registry is unavailable".to_string())?;
|
||||
if let Some(label) = state.by_download.get(download_id) {
|
||||
return Ok(label.clone());
|
||||
}
|
||||
|
||||
let label = format!("{PROPERTIES_LABEL_PREFIX}{}", Uuid::new_v4().simple());
|
||||
state.by_download.insert(download_id.to_string(), label.clone());
|
||||
state.by_window.insert(label.clone(), download_id.to_string());
|
||||
Ok(label)
|
||||
}
|
||||
|
||||
pub fn download_for_window(&self, label: &str) -> Result<Option<String>, String> {
|
||||
Ok(self
|
||||
.state
|
||||
.lock()
|
||||
.map_err(|_| "Properties window registry is unavailable".to_string())?
|
||||
.by_window
|
||||
.get(label)
|
||||
.cloned())
|
||||
}
|
||||
|
||||
pub fn remove_window(&self, label: &str) -> Result<Option<String>, String> {
|
||||
let mut state = self
|
||||
.state
|
||||
.lock()
|
||||
.map_err(|_| "Properties window registry is unavailable".to_string())?;
|
||||
let download_id = state.by_window.remove(label);
|
||||
if let Some(download_id) = &download_id {
|
||||
state.by_download.remove(download_id);
|
||||
}
|
||||
Ok(download_id)
|
||||
}
|
||||
|
||||
pub fn remove_download(&self, download_id: &str) -> Result<Option<String>, String> {
|
||||
let mut state = self
|
||||
.state
|
||||
.lock()
|
||||
.map_err(|_| "Properties window registry is unavailable".to_string())?;
|
||||
let label = state.by_download.remove(download_id);
|
||||
if let Some(label) = &label {
|
||||
state.by_window.remove(label);
|
||||
}
|
||||
Ok(label)
|
||||
}
|
||||
|
||||
pub fn window_for_download(&self, download_id: &str) -> Result<Option<String>, String> {
|
||||
Ok(self
|
||||
.state
|
||||
.lock()
|
||||
.map_err(|_| "Properties window registry is unavailable".to_string())?
|
||||
.by_download
|
||||
.get(download_id)
|
||||
.cloned())
|
||||
}
|
||||
}
|
||||
|
||||
pub fn is_properties_window_label(label: &str) -> bool {
|
||||
label.starts_with(PROPERTIES_LABEL_PREFIX)
|
||||
&& label.len() > PROPERTIES_LABEL_PREFIX.len()
|
||||
&& label[PROPERTIES_LABEL_PREFIX.len()..]
|
||||
.chars()
|
||||
.all(|character| character.is_ascii_hexdigit())
|
||||
}
|
||||
|
||||
/// Custom Tauri commands are not automatically narrowed by a capability's
|
||||
/// window list. Commands that a Properties child may call must therefore
|
||||
/// validate the invoking webview and its registered download explicitly.
|
||||
pub fn ensure_properties_or_main(
|
||||
caller: &tauri::WebviewWindow,
|
||||
registry: &PropertiesWindowRegistry,
|
||||
download_id: &str,
|
||||
) -> Result<(), String> {
|
||||
if caller.label() == MAIN_WINDOW_LABEL {
|
||||
return Ok(());
|
||||
}
|
||||
if !is_properties_window_label(caller.label())
|
||||
|| registry.download_for_window(caller.label())?.as_deref() != Some(download_id)
|
||||
{
|
||||
return Err("This window is not authorized for the requested download".to_string());
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn ensure_main_window(caller: &tauri::WebviewWindow) -> Result<(), String> {
|
||||
(caller.label() == MAIN_WINDOW_LABEL)
|
||||
.then_some(())
|
||||
.ok_or_else(|| "This command is available only to the main window".to_string())
|
||||
}
|
||||
|
||||
fn registered_download_for_caller(
|
||||
caller: &tauri::WebviewWindow,
|
||||
registry: &PropertiesWindowRegistry,
|
||||
) -> Result<String, String> {
|
||||
let label = caller.label();
|
||||
if !is_properties_window_label(label) {
|
||||
return Err("This window is not a Properties window".to_string());
|
||||
}
|
||||
registry
|
||||
.download_for_window(label)?
|
||||
.ok_or_else(|| "Properties window is no longer registered".to_string())
|
||||
}
|
||||
|
||||
fn is_properties_action(action: &str) -> bool {
|
||||
matches!(
|
||||
action,
|
||||
"apply-properties"
|
||||
| "pause-resume"
|
||||
| "set-download-limit"
|
||||
| "set-torrent-upload-limit"
|
||||
| "set-torrent-peer-options"
|
||||
)
|
||||
}
|
||||
|
||||
fn download_exists(db: &crate::db::DbState, download_id: &str) -> Result<bool, String> {
|
||||
let connection = db.lock()?;
|
||||
Ok(crate::db::load_downloads(&connection)?.into_iter().any(|record| {
|
||||
serde_json::from_str::<serde_json::Value>(&record)
|
||||
.ok()
|
||||
.and_then(|value| value.get("id").and_then(serde_json::Value::as_str).map(str::to_owned))
|
||||
.is_some_and(|id| id == download_id)
|
||||
}))
|
||||
}
|
||||
|
||||
fn validate_download_id(download_id: &str) -> Result<(), String> {
|
||||
let trimmed = download_id.trim();
|
||||
if trimmed.is_empty() || trimmed.len() > 256 || trimmed.chars().any(char::is_control) {
|
||||
return Err("Invalid download ID".to_string());
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
pub fn open_download_properties_window(
|
||||
app: tauri::AppHandle,
|
||||
caller: tauri::WebviewWindow,
|
||||
db: tauri::State<'_, crate::db::DbState>,
|
||||
registry: tauri::State<'_, PropertiesWindowRegistry>,
|
||||
id: String,
|
||||
) -> Result<String, String> {
|
||||
if caller.label() != MAIN_WINDOW_LABEL {
|
||||
return Err("Only the main window can open Properties windows".to_string());
|
||||
}
|
||||
validate_download_id(&id)?;
|
||||
if !download_exists(&db, &id)? {
|
||||
return Err("Download no longer exists".to_string());
|
||||
}
|
||||
|
||||
let label = registry.allocate(&id)?;
|
||||
if let Some(window) = app.get_webview_window(&label) {
|
||||
let _ = window.unminimize();
|
||||
let _ = window.show();
|
||||
let _ = window.set_focus();
|
||||
return Ok(label);
|
||||
}
|
||||
|
||||
let build_result = WebviewWindowBuilder::new(&app, &label, WebviewUrl::App("index.html".into()))
|
||||
.title(PROPERTIES_WINDOW_TITLE)
|
||||
.inner_size(1000.0, 720.0)
|
||||
.min_inner_size(760.0, 560.0)
|
||||
.resizable(true)
|
||||
.always_on_top(false)
|
||||
.build();
|
||||
if let Err(error) = build_result {
|
||||
// Two rapid main-window requests can race between the native lookup
|
||||
// above and builder creation. If the first request won, retain the
|
||||
// registry entry and focus its window instead of treating the second
|
||||
// request as a failed open.
|
||||
if let Some(window) = app.get_webview_window(&label) {
|
||||
let _ = window.unminimize();
|
||||
let _ = window.show();
|
||||
let _ = window.set_focus();
|
||||
return Ok(label);
|
||||
}
|
||||
let _ = registry.remove_window(&label);
|
||||
return Err(format!("Could not open Properties window: {error}"));
|
||||
}
|
||||
|
||||
Ok(label)
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
pub fn get_properties_window_download_id(
|
||||
caller: tauri::WebviewWindow,
|
||||
registry: tauri::State<'_, PropertiesWindowRegistry>,
|
||||
) -> Result<String, String> {
|
||||
registered_download_for_caller(&caller, ®istry)
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
pub fn properties_window_send_ready(
|
||||
caller: tauri::WebviewWindow,
|
||||
app: tauri::AppHandle,
|
||||
registry: tauri::State<'_, PropertiesWindowRegistry>,
|
||||
) -> Result<(), String> {
|
||||
let download_id = registered_download_for_caller(&caller, ®istry)?;
|
||||
app.emit_to(
|
||||
MAIN_WINDOW_LABEL,
|
||||
PROPERTIES_WINDOW_READY_EVENT,
|
||||
PropertiesWindowReadyEvent {
|
||||
window_label: caller.label().to_string(),
|
||||
download_id,
|
||||
},
|
||||
)
|
||||
.map_err(|error| error.to_string())
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
pub fn properties_window_send_action(
|
||||
caller: tauri::WebviewWindow,
|
||||
app: tauri::AppHandle,
|
||||
registry: tauri::State<'_, PropertiesWindowRegistry>,
|
||||
request_id: u64,
|
||||
action: String,
|
||||
payload: Option<serde_json::Value>,
|
||||
) -> Result<(), String> {
|
||||
if !is_properties_action(&action)
|
||||
|| action.len() > 64
|
||||
|| action.chars().any(char::is_control)
|
||||
{
|
||||
return Err("Invalid Properties action".to_string());
|
||||
}
|
||||
if let Some(payload) = payload.as_ref() {
|
||||
let payload_size = serde_json::to_vec(payload)
|
||||
.map_err(|_| "Invalid Properties action payload".to_string())?
|
||||
.len();
|
||||
if payload_size > MAX_PROPERTIES_ACTION_PAYLOAD_BYTES {
|
||||
return Err("Properties action payload is too large".to_string());
|
||||
}
|
||||
}
|
||||
let download_id = registered_download_for_caller(&caller, ®istry)?;
|
||||
app.emit_to(
|
||||
MAIN_WINDOW_LABEL,
|
||||
PROPERTIES_WINDOW_ACTION_REQUEST_EVENT,
|
||||
PropertiesWindowActionEvent {
|
||||
window_label: caller.label().to_string(),
|
||||
download_id,
|
||||
request_id,
|
||||
action,
|
||||
payload,
|
||||
},
|
||||
)
|
||||
.map_err(|error| error.to_string())
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
pub fn validate_properties_window_request(
|
||||
caller: tauri::WebviewWindow,
|
||||
registry: tauri::State<'_, PropertiesWindowRegistry>,
|
||||
window_label: String,
|
||||
download_id: String,
|
||||
) -> Result<(), String> {
|
||||
if caller.label() != MAIN_WINDOW_LABEL {
|
||||
return Err("Only the main window can validate Properties requests".to_string());
|
||||
}
|
||||
validate_download_id(&download_id)?;
|
||||
if !is_properties_window_label(&window_label) {
|
||||
return Err("Invalid Properties window label".to_string());
|
||||
}
|
||||
if registry.download_for_window(&window_label)?.as_deref() != Some(download_id.as_str()) {
|
||||
return Err("Properties window request does not match its registered download".to_string());
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
pub fn close_download_properties_window(
|
||||
caller: tauri::WebviewWindow,
|
||||
app: tauri::AppHandle,
|
||||
registry: tauri::State<'_, PropertiesWindowRegistry>,
|
||||
id: String,
|
||||
) -> Result<(), String> {
|
||||
let label = caller.label();
|
||||
let registered_id = if label == MAIN_WINDOW_LABEL {
|
||||
registry.window_for_download(&id)?.map(|_| id.clone())
|
||||
} else {
|
||||
registry.download_for_window(label)?
|
||||
};
|
||||
if registered_id.as_deref() != Some(id.as_str()) {
|
||||
return Err("Properties window close request is not registered".to_string());
|
||||
}
|
||||
if let Some(label) = registry.window_for_download(&id)? {
|
||||
if let Some(window) = app.get_webview_window(&label) {
|
||||
window.close().map_err(|error| error.to_string())?;
|
||||
}
|
||||
}
|
||||
let _ = registry.remove_download(&id);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
pub fn properties_window_registry_remove_for_download(
|
||||
caller: tauri::WebviewWindow,
|
||||
app: tauri::AppHandle,
|
||||
registry: tauri::State<'_, PropertiesWindowRegistry>,
|
||||
id: String,
|
||||
) -> Result<(), String> {
|
||||
if caller.label() != MAIN_WINDOW_LABEL {
|
||||
return Err("Only the main window can remove a Properties window".to_string());
|
||||
}
|
||||
if let Some(label) = registry.remove_download(&id)? {
|
||||
if let Some(window) = app.get_webview_window(&label) {
|
||||
let _ = window.close();
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn labels_are_opaque_and_strictly_scoped() {
|
||||
assert!(is_properties_window_label("properties-0123456789abcdef"));
|
||||
assert!(!is_properties_window_label("properties-download-id"));
|
||||
assert!(!is_properties_window_label("main"));
|
||||
assert!(!is_properties_window_label("properties-"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn registry_reuses_one_label_per_download_and_cleans_both_indexes() {
|
||||
let registry = PropertiesWindowRegistry::default();
|
||||
let first = registry.allocate("download-a").unwrap();
|
||||
assert_eq!(registry.allocate("download-a").unwrap(), first);
|
||||
assert_eq!(registry.download_for_window(&first).unwrap(), Some("download-a".to_string()));
|
||||
assert_eq!(registry.remove_window(&first).unwrap(), Some("download-a".to_string()));
|
||||
assert_eq!(registry.download_for_window(&first).unwrap(), None);
|
||||
assert_ne!(registry.allocate("download-a").unwrap(), first);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn invalid_ids_are_rejected() {
|
||||
assert!(validate_download_id("").is_err());
|
||||
assert!(validate_download_id("\n").is_err());
|
||||
assert!(validate_download_id("valid-id").is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn child_actions_are_allowlisted() {
|
||||
assert!(is_properties_action("apply-properties"));
|
||||
assert!(is_properties_action("set-torrent-peer-options"));
|
||||
assert!(!is_properties_action("get_keychain_password"));
|
||||
assert!(!is_properties_action(""));
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user