Add sidecar metadata files
Some checks failed
CI / Typos (push) Successful in 24s
CI / Clippy (push) Failing after 59s
CI / Build and test (push) Failing after 1m7s

This commit is contained in:
2026-03-05 22:02:38 -08:00
parent a9e402bc83
commit 16f1e38087
8 changed files with 122 additions and 12 deletions

View File

@@ -13,6 +13,10 @@ pub mod objectpath;
pub static INIT_DB_TOML: &str = include_str!("./config.toml"); pub static INIT_DB_TOML: &str = include_str!("./config.toml");
fn default_true() -> bool {
true
}
#[test] #[test]
#[expect(clippy::expect_used)] #[expect(clippy::expect_used)]
fn init_db_toml_valid() { fn init_db_toml_valid() {
@@ -46,8 +50,21 @@ pub struct DatasetConfig {
#[serde(tag = "type")] #[serde(tag = "type")]
#[serde(rename_all = "lowercase")] #[serde(rename_all = "lowercase")]
pub enum Source { pub enum Source {
/// A directory of FLAC files /// A directory files
Flac { path: OneOrMany<PathBuf> }, Filesystem {
/// The directories to scan.
/// Must be relative.
#[serde(alias = "paths")]
path: OneOrMany<PathBuf>,
/// If true, all toml files are ignored.
/// Metadata can be added to any file using a {filename}.toml.
///
/// If false, toml files are treated as regular files
/// and sidecar metadata is disabled.
#[serde(default = "default_true")]
sidecars: bool,
},
} }
// //

View File

@@ -103,7 +103,9 @@ impl Dataset {
) -> Option<Box<dyn Item<Key = PathBuf> + 'static>> { ) -> Option<Box<dyn Item<Key = PathBuf> + 'static>> {
let s = self.config.dataset.source.get(source)?; let s = self.config.dataset.source.get(source)?;
let s = match s { let s = match s {
Source::Flac { path } => DirDataSource::new(source, path.clone().to_vec()), Source::Filesystem { path, sidecars } => {
DirDataSource::new(source, path.clone().to_vec(), *sidecars)
}
}; };
s.get(key).ok().flatten() s.get(key).ok().flatten()
@@ -254,8 +256,8 @@ impl Dataset {
for (label, source) in &self.config.dataset.source { for (label, source) in &self.config.dataset.source {
match source { match source {
Source::Flac { path } => { Source::Filesystem { path, sidecars } => {
let s = DirDataSource::new(label, path.clone().to_vec()); let s = DirDataSource::new(label, path.clone().to_vec(), *sidecars);
match (ts, s.latest_change()?) { match (ts, s.latest_change()?) {
(_, None) => continue, (_, None) => continue,
(None, Some(new)) => ts = Some(new), (None, Some(new)) => ts = Some(new),
@@ -315,8 +317,8 @@ fn start_read_task(
info!("Loading source {name}"); info!("Loading source {name}");
match source { match source {
Source::Flac { path: dir } => { Source::Filesystem { path, sidecars } => {
let source = DirDataSource::new(name, dir.clone().to_vec()); let source = DirDataSource::new(name, path.clone().to_vec(), *sidecars);
for i in source.iter() { for i in source.iter() {
match i { match i {
Ok(x) => batch.push(x), Ok(x) => batch.push(x),

View File

@@ -27,7 +27,9 @@ impl<'a> FlacExtractor<'a> {
let mut output: HashMap<Label, Vec<_>> = HashMap::new(); let mut output: HashMap<Label, Vec<_>> = HashMap::new();
for block in reader { for block in reader {
if let FlacBlock::VorbisComment(comment) = block.unwrap() { if let FlacBlock::VorbisComment(comment) =
block.map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidData, e))?
{
for (k, v) in comment.comment.comments { for (k, v) in comment.comment.comments {
match Label::new(k.to_string().to_lowercase()) { match Label::new(k.to_string().to_lowercase()) {
Some(k) => output.entry(k).or_default().push(PileValue::String(v)), Some(k) => output.entry(k).or_default().push(PileValue::String(v)),

View File

@@ -1,14 +1,17 @@
mod flac; use pile_config::Label;
use std::{collections::HashMap, rc::Rc}; use std::{collections::HashMap, rc::Rc};
mod flac;
pub use flac::*; pub use flac::*;
mod fs; mod fs;
pub use fs::*; pub use fs::*;
mod sidecar;
pub use sidecar::*;
mod map; mod map;
pub use map::*; pub use map::*;
use pile_config::Label;
/// An attachment that extracts metadata from an [Item]. /// An attachment that extracts metadata from an [Item].
/// ///
@@ -46,6 +49,10 @@ impl<'a> MetaExtractor<'a, crate::FileItem> {
Label::new("fs").unwrap(), Label::new("fs").unwrap(),
crate::PileValue::Extractor(Rc::new(FsExtractor::new(item))), crate::PileValue::Extractor(Rc::new(FsExtractor::new(item))),
), ),
(
Label::new("sidecar").unwrap(),
crate::PileValue::Extractor(Rc::new(SidecarExtractor::new(item))),
),
]), ]),
}; };
@@ -63,6 +70,10 @@ impl Extractor<crate::FileItem> for MetaExtractor<'_, crate::FileItem> {
#[expect(clippy::unwrap_used)] #[expect(clippy::unwrap_used)]
fn fields(&self) -> Result<Vec<Label>, std::io::Error> { fn fields(&self) -> Result<Vec<Label>, std::io::Error> {
return Ok(vec![Label::new("flac").unwrap(), Label::new("fs").unwrap()]); return Ok(vec![
Label::new("flac").unwrap(),
Label::new("fs").unwrap(),
Label::new("sidecar").unwrap(),
]);
} }
} }

View File

@@ -0,0 +1,69 @@
use pile_config::Label;
use std::{collections::HashMap, sync::OnceLock};
use crate::{FileItem, Item, PileValue, extract::Extractor};
fn toml_to_pile<I: Item>(value: toml::Value) -> PileValue<'static, I> {
match value {
toml::Value::String(s) => PileValue::String(s.into()),
toml::Value::Integer(i) => PileValue::String(i.to_string().into()),
toml::Value::Float(f) => PileValue::String(f.to_string().into()),
toml::Value::Boolean(b) => PileValue::String(b.to_string().into()),
toml::Value::Datetime(d) => PileValue::String(d.to_string().into()),
toml::Value::Array(a) => PileValue::Array(a.into_iter().map(toml_to_pile).collect()),
toml::Value::Table(_) => PileValue::Null,
}
}
pub struct SidecarExtractor<'a> {
item: &'a FileItem,
output: OnceLock<HashMap<Label, PileValue<'a, FileItem>>>,
}
impl<'a> SidecarExtractor<'a> {
pub fn new(item: &'a FileItem) -> Self {
Self {
item,
output: OnceLock::new(),
}
}
fn get_inner(&self) -> Result<&HashMap<Label, PileValue<'a, FileItem>>, std::io::Error> {
if let Some(x) = self.output.get() {
return Ok(x);
}
let sidecar_file = self.item.path.with_extension("toml");
if !(sidecar_file.is_file() && self.item.sidecar) {
return Ok(self.output.get_or_init(HashMap::new));
}
let sidecar = std::fs::read_to_string(&sidecar_file)?;
let sidecar: toml::Value = toml::from_str(&sidecar)
.map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidData, e))?;
let output: HashMap<Label, PileValue<'_, FileItem>> = match sidecar {
toml::Value::Table(t) => t
.into_iter()
.filter_map(|(k, v)| Label::new(&k).map(|label| (label, toml_to_pile(v))))
.collect(),
_ => HashMap::new(),
};
return Ok(self.output.get_or_init(|| output));
}
}
impl Extractor<FileItem> for SidecarExtractor<'_> {
fn field<'a>(
&'a self,
name: &Label,
) -> Result<Option<&'a PileValue<'a, FileItem>>, std::io::Error> {
Ok(self.get_inner()?.get(name))
}
fn fields(&self) -> Result<Vec<Label>, std::io::Error> {
Ok(self.get_inner()?.keys().cloned().collect())
}
}

View File

@@ -43,6 +43,9 @@ pub struct FileItem {
/// Must be relative to source root dir. /// Must be relative to source root dir.
pub path: PathBuf, pub path: PathBuf,
pub source_name: Label, pub source_name: Label,
/// If true, look for a sidecar file
pub sidecar: bool,
} }
impl Item for FileItem { impl Item for FileItem {

View File

@@ -10,13 +10,16 @@ use crate::{DataSource, Item, item::FileItem, path_ts_latest};
pub struct DirDataSource { pub struct DirDataSource {
pub name: Label, pub name: Label,
pub dirs: Vec<PathBuf>, pub dirs: Vec<PathBuf>,
pub sidecars: bool,
} }
impl DirDataSource { impl DirDataSource {
pub fn new(name: &Label, dirs: Vec<PathBuf>) -> Self { pub fn new(name: &Label, dirs: Vec<PathBuf>, sidecars: bool) -> Self {
Self { Self {
name: name.clone(), name: name.clone(),
dirs, dirs,
sidecars,
} }
} }
} }
@@ -36,6 +39,7 @@ impl DataSource for DirDataSource {
return Ok(Some(Box::new(FileItem { return Ok(Some(Box::new(FileItem {
source_name: self.name.clone(), source_name: self.name.clone(),
path: key.to_owned(), path: key.to_owned(),
sidecar: self.sidecars,
}))); })));
} }
@@ -64,6 +68,7 @@ impl DataSource for DirDataSource {
Some("flac") => Box::new(FileItem { Some("flac") => Box::new(FileItem {
source_name: self.name.clone(), source_name: self.name.clone(),
path: path.clone(), path: path.clone(),
sidecar: self.sidecars,
}), }),
Some(_) => return None, Some(_) => return None,
}; };

View File

@@ -24,6 +24,7 @@ impl CliCmd for ProbeCommand {
let item = FileItem { let item = FileItem {
path: self.file.clone(), path: self.file.clone(),
source_name: Label::new("probe-source").unwrap(), source_name: Label::new("probe-source").unwrap(),
sidecar: true,
}; };
let value = PileValue::Extractor(Rc::new(MetaExtractor::new(&item))); let value = PileValue::Extractor(Rc::new(MetaExtractor::new(&item)));