dais_sidecar/

metadata.rs

use crate::types::{PresentationMetadata, SlideGroupMeta};

/// Attempt to extract pdfpc-compatible metadata from a raw pdfpc-format string
/// embedded in a PDF's info dictionary (typically the "pdfpc" or "pdfpcFormat" key).
///
/// `Polylux`, touying, and the `\pdfpc` LaTeX package embed metadata directly
/// into the compiled PDF (typically in the Info dictionary or XMP stream).
///
/// Returns `None` if the input is empty or cannot be parsed.
pub fn extract_embedded_metadata(raw_pdfpc_data: Option<&str>) -> Option<PresentationMetadata> {
    let data = raw_pdfpc_data?.trim();
    if data.is_empty() {
        return None;
    }

    // The embedded format is the same INI-like pdfpc format
    let meta = crate::pdfpc::parser::parse_pdfpc_str(data);

    // Only return if we actually extracted something useful
    if meta.groups.is_empty() && meta.notes.is_empty() && meta.end_slide.is_none() {
        return None;
    }

    Some(meta)
}

/// Load presentation metadata using the priority chain:
///
/// 1. Embedded PDF metadata (highest priority)
/// 2. `.dais` sidecar file (preferred native format)
/// 3. `.pdfpc` sidecar file
/// 4. No metadata (empty default)
///
/// The `pdf_path` is the path to the PDF file — sidecars are looked up
/// by replacing the extension with `.dais` or `.pdfpc`.
pub fn load_metadata(
    pdf_path: &std::path::Path,
    embedded_pdfpc_data: Option<&str>,
) -> (PresentationMetadata, MetadataSource) {
    use crate::format::SidecarFormat;

    // Priority 1: .dais sidecar file (user customizations override everything)
    let dais_path = pdf_path.with_extension("dais");
    if dais_path.exists() {
        let format = crate::dais_format::DaisFormat;
        if let Ok(meta) = format.read(&dais_path) {
            return (meta, MetadataSource::Sidecar(dais_path));
        }
        tracing::warn!("Failed to parse sidecar file: {}", dais_path.display());
    }

    // Priority 2: .pdfpc sidecar file
    let sidecar_path = pdf_path.with_extension("pdfpc");
    if sidecar_path.exists() {
        let format = crate::pdfpc::PdfpcFormat;
        if let Ok(meta) = format.read(&sidecar_path) {
            return (meta, MetadataSource::Sidecar(sidecar_path));
        }
        tracing::warn!("Failed to parse sidecar file: {}", sidecar_path.display());
    }

    // Priority 3: Embedded PDF metadata (Beamer/Quarto defaults)
    if let Some(meta) = extract_embedded_metadata(embedded_pdfpc_data) {
        return (meta, MetadataSource::Embedded);
    }

    // Priority 4: No metadata
    (PresentationMetadata::default(), MetadataSource::None)
}

/// Where the metadata was loaded from.
#[derive(Debug, Clone)]
pub enum MetadataSource {
    /// Extracted from PDF info dictionary / XMP.
    Embedded,
    /// Loaded from a sidecar file.
    Sidecar(std::path::PathBuf),
    /// No metadata found — using 1:1 page-to-slide mapping.
    None,
}

/// Parse overlay group definitions from a pdfpc-style overlay string.
///
/// Each line: `start_page end_page` (1-based).
pub fn parse_overlay_groups(overlay_str: &str) -> Vec<SlideGroupMeta> {
    let mut groups = Vec::new();
    for line in overlay_str.lines() {
        let parts: Vec<&str> = line.split_whitespace().collect();
        if parts.len() == 2
            && let (Ok(start), Ok(end)) = (parts[0].parse::<usize>(), parts[1].parse::<usize>())
        {
            groups.push(SlideGroupMeta {
                start_page: start.saturating_sub(1),
                end_page: end.saturating_sub(1),
            });
        }
    }
    groups
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn extract_none_from_empty() {
        assert!(extract_embedded_metadata(None).is_none());
        assert!(extract_embedded_metadata(Some("")).is_none());
        assert!(extract_embedded_metadata(Some("  ")).is_none());
    }

    #[test]
    fn extract_from_embedded_pdfpc_string() {
        let data = "[notes]\n### 1\nHello\n[overlay]\n1 3\n";
        let meta = extract_embedded_metadata(Some(data)).unwrap();
        assert_eq!(meta.notes.len(), 1);
        assert_eq!(meta.notes[&0], "Hello");
        assert_eq!(meta.groups.len(), 1);
    }

    #[test]
    fn extract_returns_none_if_no_useful_content() {
        let data = "[file]\ntest.pdf\n";
        assert!(extract_embedded_metadata(Some(data)).is_none());
    }

    #[test]
    fn load_metadata_with_no_sources() {
        let (meta, source) = load_metadata(std::path::Path::new("nonexistent.pdf"), None);
        assert!(meta.groups.is_empty());
        assert!(matches!(source, MetadataSource::None));
    }

    #[test]
    fn load_metadata_embedded_fallback_when_no_sidecar() {
        let data = "[overlay]\n1 3\n";
        let (meta, source) = load_metadata(std::path::Path::new("nonexistent.pdf"), Some(data));
        assert_eq!(meta.groups.len(), 1);
        assert!(matches!(source, MetadataSource::Embedded));
    }

    #[test]
    fn load_metadata_sidecar_overrides_embedded() {
        use crate::format::SidecarFormat;
        use crate::pdfpc::PdfpcFormat;

        let dir = std::env::temp_dir().join("dais_test_sidecar_over_embedded");
        let _ = std::fs::create_dir_all(&dir);
        let pdf_path = dir.join("talk.pdf");
        std::fs::write(&pdf_path, b"fake pdf").unwrap();

        // Write a .pdfpc sidecar with groups
        let sidecar_meta = PresentationMetadata {
            title: Some("Sidecar".to_string()),
            groups: vec![crate::types::SlideGroupMeta { start_page: 0, end_page: 2 }],
            ..Default::default()
        };
        PdfpcFormat.write(&dir.join("talk.pdfpc"), &sidecar_meta).unwrap();

        // Provide embedded metadata (no groups)
        let embedded = "[notes]\n### 1\nEmbedded note\n";
        let (meta, source) = load_metadata(&pdf_path, Some(embedded));

        // Sidecar should win over embedded
        assert_eq!(meta.title.as_deref(), Some("Sidecar"));
        assert_eq!(meta.groups.len(), 1);
        assert!(matches!(source, MetadataSource::Sidecar(_)));

        let _ = std::fs::remove_file(dir.join("talk.pdf"));
        let _ = std::fs::remove_file(dir.join("talk.pdfpc"));
    }

    #[test]
    fn load_metadata_dais_over_pdfpc() {
        use crate::dais_format::DaisFormat;
        use crate::format::SidecarFormat;
        use crate::pdfpc::PdfpcFormat;

        let dir = std::env::temp_dir().join("dais_test_metadata_priority");
        let _ = std::fs::create_dir_all(&dir);
        let pdf_path = dir.join("talk.pdf");
        std::fs::write(&pdf_path, b"fake pdf").unwrap();

        // Write a .dais sidecar with a distinctive title
        let dais_meta =
            PresentationMetadata { title: Some("From Dais".to_string()), ..Default::default() };
        DaisFormat.write(&dir.join("talk.dais"), &dais_meta).unwrap();

        // Write a .pdfpc sidecar with a different title
        let pdfpc_meta =
            PresentationMetadata { title: Some("From Pdfpc".to_string()), ..Default::default() };
        PdfpcFormat.write(&dir.join("talk.pdfpc"), &pdfpc_meta).unwrap();

        // .dais should win
        let (meta, source) = load_metadata(&pdf_path, None);
        assert_eq!(meta.title.as_deref(), Some("From Dais"));
        assert!(
            matches!(source, MetadataSource::Sidecar(ref p) if p.extension().unwrap() == "dais")
        );

        // Cleanup
        let _ = std::fs::remove_file(dir.join("talk.pdf"));
        let _ = std::fs::remove_file(dir.join("talk.dais"));
        let _ = std::fs::remove_file(dir.join("talk.pdfpc"));
    }

    #[test]
    fn parse_overlay_groups_basic() {
        let groups = parse_overlay_groups("1 3\n4 5\n");
        assert_eq!(groups.len(), 2);
        assert_eq!(groups[0].start_page, 0);
        assert_eq!(groups[0].end_page, 2);
        assert_eq!(groups[1].start_page, 3);
        assert_eq!(groups[1].end_page, 4);
    }
}