pdf_xfa/
classify.rs

1//! XFA form type classification — static vs dynamic vs none.
2//!
3//! XFA Spec 3.3 §9.1 distinguishes two XFA form profiles:
4//!
5//! - **Static (XFAF)**: `baseProfile="interactiveForms"` on `<template>`.
6//!   Layout is fixed; form fields are baked in as AcroForm widgets.
7//! - **Dynamic**: full XFA grammar; layout is re-computed from data at render
8//!   time.  No `baseProfile` restriction.
9//!
10//! Use [`detect_xfa_type_from_packets`] when you already have [`XfaPackets`],
11//! or [`detect_xfa_type`] to parse raw PDF bytes end-to-end.
12//!
13//! # Example
14//! ```rust,ignore
15//! use pdf_xfa::classify::{detect_xfa_type, XfaType};
16//! match detect_xfa_type(&pdf_bytes) {
17//!     XfaType::Static  => println!("XFAF / static form"),
18//!     XfaType::Dynamic => println!("full dynamic XFA"),
19//!     XfaType::None    => println!("not an XFA PDF"),
20//! }
21//! ```
22
23use crate::extract::{extract_xfa_from_bytes, XfaPackets};
24
25/// Classification of an XFA form.
26#[derive(Debug, Clone, Copy, PartialEq, Eq)]
27pub enum XfaType {
28    /// Not an XFA PDF (no XFA content found).
29    None,
30    /// Static XFA form (`baseProfile="interactiveForms"`).
31    /// Layout is fixed; content is pre-rendered in the PDF page streams.
32    Static,
33    /// Dynamic XFA form — full XFA grammar, layout computed at runtime.
34    Dynamic,
35}
36
37impl std::fmt::Display for XfaType {
38    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
39        match self {
40            XfaType::None => write!(f, "None"),
41            XfaType::Static => write!(f, "Static"),
42            XfaType::Dynamic => write!(f, "Dynamic"),
43        }
44    }
45}
46
47/// Detect XFA type from already-extracted [`XfaPackets`].
48///
49/// Returns [`XfaType::None`] when there are no packets and no full XML.
50pub fn detect_xfa_type_from_packets(packets: &XfaPackets) -> XfaType {
51    // No packets and no monolithic XML → not an XFA document.
52    if packets.packets.is_empty() && packets.full_xml.is_none() {
53        return XfaType::None;
54    }
55
56    // Look for baseProfile="interactiveForms" in the template packet first,
57    // then fall back to searching the full XDP XML blob.
58    let template_xml: Option<&str> = packets.template();
59    let full_xml: Option<&str> = packets.full_xml.as_deref();
60
61    let search_text: &str = template_xml.or(full_xml).unwrap_or("");
62
63    if search_text.contains(r#"baseProfile="interactiveForms""#) {
64        XfaType::Static
65    } else if !search_text.is_empty() || packets.packets.iter().any(|(name, _)| name == "template")
66    {
67        XfaType::Dynamic
68    } else {
69        // We have something (datasets-only, config-only, etc.) but no template.
70        // Treat as Dynamic — it is at minimum an XFA artefact.
71        XfaType::Dynamic
72    }
73}
74
75/// Detect XFA type from raw PDF bytes.
76///
77/// Parses and extracts XFA packets, then classifies the form.
78/// Returns [`XfaType::None`] when the PDF has no XFA content.
79pub fn detect_xfa_type(pdf_bytes: &[u8]) -> XfaType {
80    // extract_xfa_from_bytes requires Into<PdfData>; Vec<u8> satisfies that.
81    match extract_xfa_from_bytes(pdf_bytes.to_vec()) {
82        Ok(packets) => detect_xfa_type_from_packets(&packets),
83        Err(_) => XfaType::None,
84    }
85}
86
87// ─── unit tests ─────────────────────────────────────────────────────────────
88
89#[cfg(test)]
90mod tests {
91    use super::*;
92    use crate::extract::XfaPackets;
93
94    fn packets_from_xml(xml: &str) -> XfaPackets {
95        // Use the internal parse helper via extract module's public surface.
96        // We build XfaPackets by hand to keep tests self-contained.
97        let mut p = XfaPackets {
98            full_xml: Some(xml.to_string()),
99            ..Default::default()
100        };
101        // Manually push the template packet so get_packet("template") works.
102        if xml.contains("<template") {
103            let start = xml.find("<template").unwrap();
104            // Find the closing tag — handle both qualified and plain versions.
105            let end = xml
106                .find("</template>")
107                .map(|i| i + "</template>".len())
108                .or({
109                    // self-closing or other variant — take to end of xml as fallback
110                    Some(xml.len())
111                })
112                .unwrap();
113            p.packets
114                .push(("template".to_string(), xml[start..end].to_string()));
115        }
116        p
117    }
118
119    #[test]
120    fn empty_packets_returns_none() {
121        let p = XfaPackets::default();
122        assert_eq!(detect_xfa_type_from_packets(&p), XfaType::None);
123    }
124
125    #[test]
126    fn static_form_detected_via_base_profile() {
127        let xml = r#"<xdp:xdp xmlns:xdp="http://ns.adobe.com/xdp/"><template xmlns="http://www.xfa.org/schema/xfa-template/3.3/" baseProfile="interactiveForms"><subform name="root"/></template></xdp:xdp>"#;
128        let p = packets_from_xml(xml);
129        assert_eq!(detect_xfa_type_from_packets(&p), XfaType::Static);
130    }
131
132    #[test]
133    fn dynamic_form_detected_when_no_base_profile() {
134        let xml = r#"<xdp:xdp xmlns:xdp="http://ns.adobe.com/xdp/"><template xmlns="http://www.xfa.org/schema/xfa-template/3.3/"><subform name="root"><occur min="0" max="-1"/></subform></template></xdp:xdp>"#;
135        let p = packets_from_xml(xml);
136        assert_eq!(detect_xfa_type_from_packets(&p), XfaType::Dynamic);
137    }
138
139    #[test]
140    fn xfa_type_none_on_empty_pdf_bytes() {
141        // Empty slice cannot be a valid PDF → XfaType::None.
142        assert_eq!(detect_xfa_type(&[]), XfaType::None);
143    }
144
145    #[test]
146    fn xfa_type_display() {
147        assert_eq!(XfaType::None.to_string(), "None");
148        assert_eq!(XfaType::Static.to_string(), "Static");
149        assert_eq!(XfaType::Dynamic.to_string(), "Dynamic");
150    }
151
152    #[test]
153    fn packets_with_only_full_xml_static() {
154        // Simulate a monolithic XDP stream (full_xml set, packets empty).
155        let xml = r#"<?xml version="1.0"?><xdp:xdp xmlns:xdp="http://ns.adobe.com/xdp/"><template baseProfile="interactiveForms"><subform/></template></xdp:xdp>"#;
156        let p = XfaPackets {
157            full_xml: Some(xml.to_string()),
158            ..Default::default()
159        };
160        // No individual packets — detect from full_xml fallback.
161        assert_eq!(detect_xfa_type_from_packets(&p), XfaType::Static);
162    }
163
164    #[test]
165    fn datasets_only_packet_treated_as_dynamic() {
166        let mut p = XfaPackets::default();
167        p.packets
168            .push(("datasets".to_string(), "<xfa:datasets/>".to_string()));
169        // datasets-only is still an XFA artefact — Dynamic.
170        assert_eq!(detect_xfa_type_from_packets(&p), XfaType::Dynamic);
171    }
172}
pdf_xfa/classify.rs

pdf_xfa/
classify.rs
