kristoferssolo/traxor
1
0
Fork 0
mirror of https://github.com/kristoferssolo/traxor.git synced 2026-01-14 20:46:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat: add configurable custom tabs with user-defined columns

Browse Source
This commit is contained in:
Kristofers Solo 2026-01-01 04:42:15 +02:00
parent 59f86c31e5
commit eba2eefc5e
Signed by: kristoferssolo
GPG Key ID: 8687F2D3EEE6F0ED
6 changed files with 177 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
config/default.toml
View File

@ -26,3 +26,24 @@ error_foreground = "red"
traxor = "info"
ratatui = "warn"
transmission_rpc = "warn"
# Custom tabs configuration
# Each [[tabs]] entry defines a tab with a name and list of columns.
# Available columns:
# name, status, size, downloaded, uploaded, ratio, progress, eta,
# peers, seeds, leeches, downspeed, upspeed, path, added, done,
# left, queue, error, labels, tracker, hash, private, stalled,
# finished, files, activity
#
# Example:
# [[tabs]]
# name = "All"
# columns = ["status", "ratio", "size", "uploaded", "path", "name"]
#
# [[tabs]]
# name = "Active"
# columns = ["progress", "downspeed", "upspeed", "eta", "name"]
#
# [[tabs]]
# name = "Downloading"
# columns = ["size", "left", "progress", "downspeed", "eta", "name"]

3
src/app/mod.rs
View File

@ -47,9 +47,10 @@ impl App {
///
/// TODO: add error types
pub fn new(config: Config) -> Result<Self> {
let tabs = config.tabs.iter().cloned().map(Tab::new).collect();
Ok(Self {
running: true,
tabs: vec![Tab::All, Tab::Active, Tab::Downloading],
tabs,
index: 0,
state: TableState::default(),
torrents: Torrents::new()?,

80
src/app/tab.rs
View File

@ -1,79 +1,37 @@
use crate::config::tabs::TabConfig;
use std::fmt::Display;
use transmission_rpc::types::TorrentGetField;
/// Available tabs.
#[derive(Debug, Clone, Default)]
pub enum Tab {
#[default]
All,
Active,
Downloading,
/// A tab with name and column configuration.
#[derive(Debug, Clone)]
pub struct Tab {
config: TabConfig,
fields: Vec<TorrentGetField>,
}
impl Tab {
/// Returns slice [`TorrentGetField`] apropriate variants.
/// Create a new tab from config.
#[must_use]
pub const fn fields(&self) -> &[TorrentGetField] {
match self {
Self::All => &[
TorrentGetField::Status,
TorrentGetField::PeersGettingFromUs,
TorrentGetField::UploadRatio,
TorrentGetField::TotalSize,
TorrentGetField::UploadedEver,
TorrentGetField::DownloadDir,
TorrentGetField::Name,
],
Self::Active => &[
TorrentGetField::TotalSize,
TorrentGetField::UploadedEver,
TorrentGetField::UploadRatio,
TorrentGetField::PeersGettingFromUs,
TorrentGetField::PeersSendingToUs,
TorrentGetField::Status,
TorrentGetField::Eta,
TorrentGetField::PercentDone,
TorrentGetField::RateDownload,
TorrentGetField::RateUpload,
TorrentGetField::Name,
],
Self::Downloading => &[
TorrentGetField::TotalSize,
TorrentGetField::LeftUntilDone,
TorrentGetField::PercentDone,
TorrentGetField::RateDownload,
TorrentGetField::Eta,
TorrentGetField::DownloadDir,
TorrentGetField::Name,
],
}
}
pub fn new(config: TabConfig) -> Self {
let fields = config.fields();
Self { config, fields }
}
impl From<usize> for Tab {
fn from(value: usize) -> Self {
#[allow(clippy::match_same_arms)]
match value {
0 => Self::All,
1 => Self::Active,
2 => Self::Downloading,
_ => Self::All,
}
}
/// Returns the column fields for this tab.
#[must_use]
pub fn fields(&self) -> &[TorrentGetField] {
&self.fields
}
impl AsRef<str> for Tab {
fn as_ref(&self) -> &str {
match self {
Self::All => "All",
Self::Active => "Active",
Self::Downloading => "Downloading",
}
/// Returns the tab name.
#[must_use]
pub fn name(&self) -> &str {
&self.config.name
}
}
impl Display for Tab {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.as_ref())
write!(f, "{}", self.config.name)
}
}

36
src/config/mod.rs
View File

@ -1,6 +1,7 @@
pub mod color;
pub mod keybinds;
pub mod log;
pub mod tabs;
use color::ColorConfig;
use color_eyre::{
@ -11,10 +12,12 @@ use filecaster::FromFile;
use keybinds::KeybindsConfig;
use log::LogConfig;
use merge::Merge;
use serde::Deserialize;
use std::{
fs::read_to_string,
path::{Path, PathBuf},
};
use tabs::TabConfig;
use tracing::{debug, info, warn};
const DEFAULT_CONFIG_STR: &str = include_str!("../../config/default.toml");
@ -24,6 +27,15 @@ pub struct Config {
pub keybinds: KeybindsConfig,
pub colors: ColorConfig,
pub log: LogConfig,
#[from_file(skip)]
pub tabs: Vec<TabConfig>,
}
/// Helper struct for parsing tabs from TOML.
#[derive(Debug, Deserialize, Default)]
struct TabsFile {
#[serde(default)]
tabs: Vec<TabConfig>,
}
impl Config {
@ -50,12 +62,34 @@ impl Config {
("user-specific", get_config_path()?),
];
let mut tabs: Option<Vec<TabConfig>> = None;
for (label, path) in &candidates {
merge_config(&mut cfg_file, label, path)?;
// Load tabs separately (last one wins)
if let Some(t) = load_tabs(path) {
tabs = Some(t);
}
}
let mut config: Self = cfg_file.into();
config.tabs = tabs.unwrap_or_else(tabs::default_tabs);
debug!("Configuration loaded successfully.");
Ok(cfg_file.into())
Ok(config)
}
}
fn load_tabs(path: &Path) -> Option<Vec<TabConfig>> {
if !path.exists() {
return None;
}
let content = read_to_string(path).ok()?;
let tabs_file: TabsFile = toml::from_str(&content).ok()?;
if tabs_file.tabs.is_empty() {
None
} else {
Some(tabs_file.tabs)
}
}

98
src/config/tabs.rs Normal file
View File

@ -0,0 +1,98 @@
use serde::{Deserialize, Serialize};
use transmission_rpc::types::TorrentGetField;
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct TabConfig {
pub name: String,
pub columns: Vec<String>,
}
impl TabConfig {
/// Parse column strings into `TorrentGetField` variants.
#[must_use]
pub fn fields(&self) -> Vec<TorrentGetField> {
self.columns.iter().filter_map(|s| parse_field(s)).collect()
}
}
fn parse_field(s: &str) -> Option<TorrentGetField> {
// Match against known field names (case-insensitive)
Some(match s.to_lowercase().as_str() {
"name" => TorrentGetField::Name,
"status" => TorrentGetField::Status,
"size" | "totalsize" | "total_size" => TorrentGetField::TotalSize,
"downloaded" | "downloadedever" | "downloaded_ever" => TorrentGetField::DownloadedEver,
"uploaded" | "uploadedever" | "uploaded_ever" => TorrentGetField::UploadedEver,
"ratio" | "uploadratio" | "upload_ratio" => TorrentGetField::UploadRatio,
"progress" | "percent" | "percentdone" | "percent_done" => TorrentGetField::PercentDone,
"eta" => TorrentGetField::Eta,
"peers" | "peersconnected" | "peers_connected" => TorrentGetField::PeersConnected,
"seeds" | "peerssending" | "peers_sending" => TorrentGetField::PeersSendingToUs,
"leeches" | "peersgetting" | "peers_getting" => TorrentGetField::PeersGettingFromUs,
"downspeed" | "ratedownload" | "rate_download" => TorrentGetField::RateDownload,
"upspeed" | "rateupload" | "rate_upload" => TorrentGetField::RateUpload,
"path" | "downloaddir" | "download_dir" => TorrentGetField::DownloadDir,
"added" | "addeddate" | "added_date" => TorrentGetField::AddedDate,
"done" | "donedate" | "done_date" => TorrentGetField::DoneDate,
"left" | "leftuntildone" | "left_until_done" => TorrentGetField::LeftUntilDone,
"queue" | "queueposition" | "queue_position" => TorrentGetField::QueuePosition,
"error" => TorrentGetField::Error,
"errorstring" | "error_string" => TorrentGetField::ErrorString,
"labels" => TorrentGetField::Labels,
"tracker" | "trackerlist" | "tracker_list" => TorrentGetField::TrackerList,
"hash" | "hashstring" | "hash_string" => TorrentGetField::HashString,
"private" | "isprivate" | "is_private" => TorrentGetField::IsPrivate,
"stalled" | "isstalled" | "is_stalled" => TorrentGetField::IsStalled,
"finished" | "isfinished" | "is_finished" => TorrentGetField::IsFinished,
"files" | "filecount" | "file_count" => TorrentGetField::FileCount,
"activity" | "activitydate" | "activity_date" => TorrentGetField::ActivityDate,
_ => return None,
})
}
/// Default tabs matching original hardcoded behavior.
#[must_use]
pub fn default_tabs() -> Vec<TabConfig> {
vec![
TabConfig {
name: "All".into(),
columns: vec![
"status".into(),
"peers_getting".into(),
"ratio".into(),
"size".into(),
"uploaded".into(),
"path".into(),
"name".into(),
],
},
TabConfig {
name: "Active".into(),
columns: vec![
"size".into(),
"uploaded".into(),
"ratio".into(),
"peers_getting".into(),
"seeds".into(),
"status".into(),
"eta".into(),
"progress".into(),
"downspeed".into(),
"upspeed".into(),
"name".into(),
],
},
TabConfig {
name: "Downloading".into(),
columns: vec![
"size".into(),
"left".into(),
"progress".into(),
"downspeed".into(),
"eta".into(),
"path".into(),
"name".into(),
],
},
]
}

4
src/ui/mod.rs
View File

@ -4,7 +4,7 @@ mod status;
mod table;
use crate::{
app::{App, InputMode, Tab},
app::{App, InputMode},
config::color::ColorConfig,
};
use help::render_help;
@ -55,7 +55,7 @@ pub fn render(app: &mut App, frame: &mut Frame) {
let selected = &app.torrents.selected;
let colors = &app.config.colors;
let table = build_table(torrents, selected, colors, Tab::from(app.index()).fields());
let table = build_table(torrents, selected, colors, app.tabs()[app.index()].fields());
frame.render_stateful_widget(table, chunks[1], &mut app.state);