mirror of
https://github.com/storytold/pdfcraft.git
synced 2026-11-18 00:26:04 +00:00
M11: PDF/A verify names the metadata stream of a mistyped XMP property (optimize.pdfa-validate)
A 6.6.2.3.1 issue now says which metadata stream holds the property
("in metadata stream 5 0 R") and carries its ObjRef in Issue::object, so a
property mistyped in more than one stream is reported once per stream.
Wordings that name more than one thing use named holes, such as {object},
filled in one pass with the {} value, so a translation can reorder them.
Tests: the stream is named and located per issue; a non-preferred prefix
bound to the TIFF, EXIF or aux namespace URI is checked, and the preferred
prefixes bound to other URIs are not, proving the lookup is by URI.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
8bbe2cdd46
commit
173cfa5390
4 files changed
+130
-32
No files matched your search
+70
-16
@@ -64,18 +64,25 @@ impl Level {
|
||||
/// another language says it from [`pattern`](Issue::pattern) and [`value`](Issue::value) instead:
|
||||
/// the pattern is wording of ours, listed in [`WORDINGS`], and the value — when there is one — is
|
||||
/// the document's own name for something, a PDF keyword that reads the same in every language.
|
||||
/// A wording that names more than one thing has a named hole, such as `{object}`, for each, so a
|
||||
/// language can put them in its own order; [`values`](Issue::values) fills those.
|
||||
/// [`Issue::said`] does that.
|
||||
#[derive(Clone, Debug, PartialEq)]
|
||||
pub struct Issue {
|
||||
/// The ISO 19005-2 clause.
|
||||
pub clause: &'static str,
|
||||
pub message: String,
|
||||
/// The problem as it is worded here, with `{}` where the document's own name goes.
|
||||
/// The problem as it is worded here, with `{}` or a named hole where the document's own name goes.
|
||||
pub pattern: &'static str,
|
||||
/// What goes in the pattern's `{}`: an annotation subtype, an action, a font, a page number.
|
||||
pub value: Option<String>,
|
||||
/// What goes in each of the pattern's named holes, by the hole's name (`"{object}"`, braces
|
||||
/// included).
|
||||
pub values: Vec<(&'static str, String)>,
|
||||
/// 0-based page, when the problem is on a page.
|
||||
pub page: Option<usize>,
|
||||
/// The indirect object the problem is in, when that is what locates it: a metadata stream.
|
||||
pub object: Option<ObjRef>,
|
||||
/// Whether [`convert`] can fix it.
|
||||
pub fixable: bool,
|
||||
}
|
||||
@@ -87,14 +94,43 @@ impl Issue {
|
||||
/// font called `{}` cannot turn into anything else. With [`in_english`] this is
|
||||
/// [`message`](Issue::message).
|
||||
pub fn said(&self, words: Words) -> String {
|
||||
let said = words(self.pattern);
|
||||
match &self.value {
|
||||
Some(v) => said.replacen("{}", v, 1),
|
||||
None => said,
|
||||
}
|
||||
fill(&words(self.pattern), self.value.as_deref(), &self.values)
|
||||
}
|
||||
}
|
||||
|
||||
/// `wording` with its holes filled: the first `{}` with `value`, and each named hole, such as
|
||||
/// `{object}`, with its entry in `values`. A hole with nothing for it stays as it is written.
|
||||
///
|
||||
/// The values go in during one pass over the wording, so a value with braces in it is never read
|
||||
/// as a hole.
|
||||
fn fill(wording: &str, value: Option<&str>, values: &[(&str, String)]) -> String {
|
||||
let mut out = String::with_capacity(wording.len().saturating_add(16));
|
||||
let mut value = value;
|
||||
let mut rest = wording;
|
||||
while let Some(open) = rest.find('{') {
|
||||
let (before, from_brace) = rest.split_at(open);
|
||||
out.push_str(before);
|
||||
// A brace with nothing closing it is just text. `}` is one byte, so the end of the hole is a
|
||||
// char boundary; `get` rather than slicing all the same.
|
||||
let Some(hole) = from_brace.find('}').and_then(|close| from_brace.get(..=close)) else {
|
||||
out.push_str(from_brace);
|
||||
return out;
|
||||
};
|
||||
if hole == "{}"
|
||||
&& let Some(v) = value.take()
|
||||
{
|
||||
out.push_str(v);
|
||||
} else if let Some((_, v)) = values.iter().find(|(name, _)| *name == hole) {
|
||||
out.push_str(v);
|
||||
} else {
|
||||
out.push_str(hole);
|
||||
}
|
||||
rest = from_brace.get(hole.len()..).unwrap_or_default();
|
||||
}
|
||||
out.push_str(rest);
|
||||
out
|
||||
}
|
||||
|
||||
/// How an interface says one of our wordings in its own language: given the English in [`WORDINGS`],
|
||||
/// the same wording in that language. [`in_english`] keeps the English.
|
||||
pub type Words<'a> = &'a dyn Fn(&str) -> String;
|
||||
@@ -104,7 +140,8 @@ pub fn in_english(wording: &str) -> String {
|
||||
wording.to_owned()
|
||||
}
|
||||
|
||||
/// Every problem [`verify`] can report, in English, with `{}` where the document's own name goes.
|
||||
/// Every problem [`verify`] can report, in English, with `{}` or a named hole, such as `{object}`,
|
||||
/// where the document's own name goes.
|
||||
///
|
||||
/// An interface that shows them in another language translates these, which is the whole reason they
|
||||
/// are gathered here; `wordings_are_complete` fails if a rule says something that is not on the
|
||||
@@ -114,7 +151,7 @@ pub const WORDINGS: &[&str] = &[
|
||||
"The document has no XMP metadata",
|
||||
"The metadata doesn't identify the file as {}",
|
||||
"The title in the metadata and the document information differ",
|
||||
"The XMP property {} doesn't have the value type the XMP Specification gives it",
|
||||
"The XMP property {property} in metadata stream {object} doesn't have the value type the XMP Specification gives it",
|
||||
// The document as a whole.
|
||||
"The document is encrypted",
|
||||
"Device colour is used, but there is no PDF/A output intent",
|
||||
@@ -429,15 +466,24 @@ thread_local! {
|
||||
|
||||
/// Check `doc` against `level`.
|
||||
pub fn verify(doc: &Document, level: Level) -> Vec<Issue> {
|
||||
let mut out = Vec::new();
|
||||
// Shared by `issue` and `located_issue`, each of which takes the list out, adds one issue and
|
||||
// puts it back.
|
||||
let out = std::cell::Cell::new(Vec::new());
|
||||
let push = |i: Issue| {
|
||||
let mut list = out.take();
|
||||
list.push(i);
|
||||
out.set(list);
|
||||
};
|
||||
// Each problem is worded here and named by the document there: the wording goes on the list in
|
||||
// `WORDINGS` for an interface to translate, and the name goes in its `{}` as it stands.
|
||||
let mut issue = |clause: &'static str, pattern: &'static str, value: Option<String>, page: Option<usize>, fixable: bool| {
|
||||
let message = match &value {
|
||||
Some(v) => pattern.replacen("{}", v, 1),
|
||||
None => pattern.to_owned(),
|
||||
};
|
||||
out.push(Issue { clause, message, pattern, value, page, fixable });
|
||||
let message = fill(pattern, value.as_deref(), &[]);
|
||||
push(Issue { clause, message, pattern, value, values: Vec::new(), page, object: None, fixable });
|
||||
};
|
||||
// A problem in one indirect object, worded with named holes.
|
||||
let located_issue = |clause: &'static str, pattern: &'static str, values: Vec<(&'static str, String)>, object: ObjRef, fixable: bool| {
|
||||
let message = fill(pattern, None, &values);
|
||||
push(Issue { clause, message, pattern, value: None, values, page: None, object: Some(object), fixable });
|
||||
};
|
||||
let cat = catalog(doc);
|
||||
// 6.1.3 / 6.6: identification and metadata.
|
||||
@@ -463,8 +509,15 @@ pub fn verify(doc: &Document, level: Level) -> Vec<Issue> {
|
||||
// 6.2.2: output intent when device colour is used.
|
||||
let objs = objects(doc);
|
||||
// 6.6.2.3.1: the value types of predefined XMP properties, in every metadata stream.
|
||||
for name in xmp_types::mistyped_in(&objs) {
|
||||
issue("6.6.2.3.1", "The XMP property {} doesn't have the value type the XMP Specification gives it", Some(name), None, false);
|
||||
for (object, name) in xmp_types::mistyped_in(&objs) {
|
||||
let values = vec![("{property}", name), ("{object}", object.to_string())];
|
||||
located_issue(
|
||||
"6.6.2.3.1",
|
||||
"The XMP property {property} in metadata stream {object} doesn't have the value type the XMP Specification gives it",
|
||||
values,
|
||||
object,
|
||||
false,
|
||||
);
|
||||
}
|
||||
let used = uses_device_colour(doc, &objs);
|
||||
match pdfa_intent_profile(doc) {
|
||||
@@ -522,6 +575,7 @@ pub fn verify(doc: &Document, level: Level) -> Vec<Issue> {
|
||||
}
|
||||
check_objects(doc, level, &objs, &page_of, &mut issue);
|
||||
// One message per kind of problem is enough for repeated ones (as preflight summaries do).
|
||||
let mut out = out.into_inner();
|
||||
let mut seen = std::collections::HashSet::new();
|
||||
out.retain(|i| seen.insert((i.clause, i.message.clone(), i.page)));
|
||||
out
|
||||
|
||||
@@ -78,12 +78,14 @@ fn wordings_are_complete() {
|
||||
let source = include_str!("lib.rs");
|
||||
let mut said = Vec::new();
|
||||
let mut rest = source;
|
||||
while let Some(at) = rest.find("issue(\"") {
|
||||
rest = &rest[at + 7..];
|
||||
// `issue(` and `located_issue(`, written on one line or, when rustfmt breaks it, on several.
|
||||
while let Some(at) = rest.find("issue(") {
|
||||
rest = &rest[at + 6..];
|
||||
let Some(clause) = rest.trim_start().strip_prefix('"') else { continue };
|
||||
// Step over the clause, then take the wording that follows it.
|
||||
let Some(end) = rest.find('"') else { break };
|
||||
rest = &rest[end + 1..];
|
||||
let Some(text) = rest.strip_prefix(", \"") else { continue };
|
||||
let Some(end) = clause.find('"') else { break };
|
||||
rest = &clause[end + 1..];
|
||||
let Some(text) = rest.strip_prefix(',').map(str::trim_start).and_then(|r| r.strip_prefix('"')) else { continue };
|
||||
let Some(end) = text.find('"') else { break };
|
||||
said.push(&text[..end]);
|
||||
rest = text;
|
||||
@@ -660,7 +662,7 @@ fn xmp_value_types_are_reported_by_verify() {
|
||||
format!("<< /Type /Metadata /Subtype /XML /Length {} >>\nstream\n{xmp}\nendstream", xmp.len())
|
||||
};
|
||||
let issues = |doc: &Document| -> Vec<Issue> { verify(doc, Level::A2b).into_iter().filter(|i| i.clause == "6.6.2.3.1").collect() };
|
||||
// Every mistyped property, each once, in name order; not fixable.
|
||||
// Every mistyped property, once per metadata stream, by stream and then by name; not fixable.
|
||||
let catalog = metadata(r#"crs:Contrast="high" crs:Exposure="bright""#);
|
||||
let page = metadata(r#"crs:Contrast="higher""#);
|
||||
let doc = build(
|
||||
@@ -678,11 +680,19 @@ fn xmp_value_types_are_reported_by_verify() {
|
||||
assert_eq!(
|
||||
messages,
|
||||
[
|
||||
"The XMP property crs:Contrast doesn't have the value type the XMP Specification gives it",
|
||||
"The XMP property crs:Exposure doesn't have the value type the XMP Specification gives it"
|
||||
"The XMP property crs:Contrast in metadata stream 3 0 R doesn't have the value type the XMP Specification gives it",
|
||||
"The XMP property crs:Exposure in metadata stream 3 0 R doesn't have the value type the XMP Specification gives it",
|
||||
"The XMP property crs:Contrast in metadata stream 5 0 R doesn't have the value type the XMP Specification gives it"
|
||||
]
|
||||
);
|
||||
assert!(found.iter().all(|i| !i.fixable));
|
||||
let objects: Vec<Option<ObjRef>> = found.iter().map(|i| i.object).collect();
|
||||
assert_eq!(objects, [Some(ObjRef::new(3, 0)), Some(ObjRef::new(3, 0)), Some(ObjRef::new(5, 0))]);
|
||||
assert!(found.iter().all(|i| !i.fixable && i.page.is_none()));
|
||||
// Said in another language, the property and the stream go where that language puts them, and
|
||||
// what the document wrote goes in as it stands.
|
||||
let reordered = |w: &str| w.replace("The XMP property {property} in metadata stream {object}", "In {object}, {property}");
|
||||
assert_eq!(found[0].said(&in_english), found[0].message);
|
||||
assert!(found[0].said(&reordered).starts_with("In 3 0 R, crs:Contrast doesn't"), "{}", found[0].said(&reordered));
|
||||
// A UTF-16 packet, either byte order, is read.
|
||||
for big in [true, false] {
|
||||
let xmp = format!(
|
||||
@@ -707,7 +717,8 @@ fn xmp_value_types_are_reported_by_verify() {
|
||||
],
|
||||
"",
|
||||
);
|
||||
assert_eq!(issues(&doc).len(), 1);
|
||||
let found = issues(&doc);
|
||||
assert_eq!(found.iter().map(|i| i.object).collect::<Vec<_>>(), [Some(ObjRef::new(5, 0))]);
|
||||
}
|
||||
|
||||
/// PDF/A-2 6.6.2.3.1 for the TIFF, EXIF and Additional EXIF schemas of the September 2005 XMP
|
||||
@@ -765,6 +776,38 @@ fn xmp_exif_schemas_have_their_value_types() {
|
||||
assert_eq!(element("aux:SerialNumber", "<rdf:Bag><rdf:li>1</rdf:li></rdf:Bag>"), ["aux:SerialNumber"]);
|
||||
}
|
||||
|
||||
/// PDF/A-2 6.6.2.3.1 for the TIFF, EXIF and Additional EXIF schemas: a property is known by its
|
||||
/// namespace URI, whatever prefix the packet binds to it, and is named by the namespace's
|
||||
/// preferred prefix.
|
||||
#[test]
|
||||
fn xmp_exif_properties_are_known_by_namespace_uri() {
|
||||
let tiff = r#"xmlns:foo="http://ns.adobe.com/tiff/1.0/""#;
|
||||
assert_eq!(mistyped(&format!(r#"><foo:ImageWidth {tiff}>256 mm</foo:ImageWidth>"#)), ["tiff:ImageWidth"]);
|
||||
assert!(mistyped(&format!(r#"><foo:ImageWidth {tiff}>256</foo:ImageWidth>"#)).is_empty());
|
||||
assert_eq!(mistyped(r#"xmlns:bar="http://ns.adobe.com/exif/1.0/" bar:GPSLatitude="51.5N">"#), ["exif:GPSLatitude"]);
|
||||
assert_eq!(
|
||||
mistyped(r#"><baz:Lens xmlns:baz="http://ns.adobe.com/exif/1.0/aux/"><rdf:Seq><rdf:li>50mm</rdf:li></rdf:Seq></baz:Lens>"#),
|
||||
["aux:Lens"]
|
||||
);
|
||||
// The same local names in another namespace, even under the preferred prefixes, are not these
|
||||
// properties.
|
||||
let other = r#"xmlns:tiff="http://example.com/not-tiff/""#;
|
||||
assert!(mistyped(&format!(r#"><tiff:ImageWidth {other}>256 mm</tiff:ImageWidth>"#)).is_empty());
|
||||
assert!(mistyped(r#"xmlns:exif="http://example.com/not-exif/" exif:GPSLatitude="51.5N">"#).is_empty());
|
||||
assert!(mistyped(r#"><aux:Lens xmlns:aux="http://example.com/not-aux/"><rdf:Seq><rdf:li>50mm</rdf:li></rdf:Seq></aux:Lens>"#).is_empty());
|
||||
}
|
||||
|
||||
/// Holes are filled in one pass: the first `{}` from `value`, named holes from `values`, and what
|
||||
/// has nothing for it, a value's own braces and a brace left open stay as they are.
|
||||
#[test]
|
||||
fn wordings_fill_their_holes_once() {
|
||||
let values = [("{a}", "{b}".to_owned()), ("{b}", "B".to_owned())];
|
||||
assert_eq!(fill("x {a} {b} {c} {} {}", Some("{a}"), &values), "x {b} B {c} {a} {}");
|
||||
assert_eq!(fill("{}", None, &[]), "{}");
|
||||
assert_eq!(fill("open { and é {a", Some("v"), &values), "open { and é {a");
|
||||
assert_eq!(fill("é{}ü", Some("v"), &[]), "évü");
|
||||
}
|
||||
|
||||
/// PDF/A-2 6.6.2.3.1, the RDF/XML value forms XMP allows (ISO 16684-1 7.9.2.5): one `rdf:value`
|
||||
/// in a qualified value, no parse type but `Resource`, and an `rdf:resource` element left empty.
|
||||
#[test]
|
||||
|
||||
@@ -589,11 +589,12 @@ const SCHEMAS: &[Schema] = &[
|
||||
];
|
||||
|
||||
/// The properties of predefined schemas whose values don't have their type, in every metadata
|
||||
/// stream among the indirect objects `objs` (ISO 32000-1 14.3.2), as `prefix:name` in name order.
|
||||
pub(crate) fn mistyped_in(objs: &[(ObjRef, std::sync::Arc<Object>)]) -> BTreeSet<String> {
|
||||
let mut out = BTreeSet::new();
|
||||
/// stream among the indirect objects `objs` (ISO 32000-1 14.3.2): the stream and the property as
|
||||
/// `prefix:name`, by stream in the order of `objs` and by name within one.
|
||||
pub(crate) fn mistyped_in(objs: &[(ObjRef, std::sync::Arc<Object>)]) -> Vec<(ObjRef, String)> {
|
||||
let mut out = Vec::new();
|
||||
let mut budget = DecodeBudget::new(MAX_METADATA_BYTES, 0);
|
||||
for (_, o) in objs {
|
||||
for (r, o) in objs {
|
||||
let Object::Stream(s) = &**o else { continue };
|
||||
if s.dict.name(b"Type") != Some(b"Metadata") {
|
||||
continue;
|
||||
@@ -604,7 +605,7 @@ pub(crate) fn mistyped_in(objs: &[(ObjRef, std::sync::Arc<Object>)]) -> BTreeSet
|
||||
let Ok(bytes) = budget.decode_within(s, crate::xmp::MAX_XMP_BYTES) else { continue };
|
||||
let text = unicode(&bytes);
|
||||
if let Some(parsed) = crate::xmp::parse(&text) {
|
||||
out.extend(mistyped(&parsed));
|
||||
out.extend(mistyped(&parsed).into_iter().map(|name| (*r, name)));
|
||||
}
|
||||
}
|
||||
out
|
||||
|
||||
@@ -8003,7 +8003,7 @@ milestone = "M11"
|
||||
status = "partial"
|
||||
commands = ["standards.pdfa"]
|
||||
tools = ["pdfa_verify"]
|
||||
evidence = ["crates/preflight/src/tests.rs::verify_reports_what_breaks_pdfa", "crates/preflight/src/tests.rs::standards_identification_uses_namespace_not_prefix", "crates/preflight/src/tests.rs::convert_fixes_all_but_fonts", "crates/preflight/src/tests.rs::verify_reports_an_output_intent_that_does_not_match_device_colour", "crates/preflight/src/tests.rs::xmp_simple_values_have_their_lexical_forms", "crates/preflight/src/tests.rs::xmp_arrays_have_their_kind_and_item_types", "crates/preflight/src/tests.rs::xmp_structures_have_their_field_types", "crates/preflight/src/tests.rs::xmp_value_types_are_reported_by_verify", "crates/preflight/src/tests.rs::xmp_exif_schemas_have_their_value_types", "crates/automation/tests/it/automation.rs::pdfa_through_tools", "crates/ui-egui/tests/it/compare.rs::pdfa_dialog_verifies_and_converts"]
|
||||
evidence = ["crates/preflight/src/tests.rs::verify_reports_what_breaks_pdfa", "crates/preflight/src/tests.rs::standards_identification_uses_namespace_not_prefix", "crates/preflight/src/tests.rs::convert_fixes_all_but_fonts", "crates/preflight/src/tests.rs::verify_reports_an_output_intent_that_does_not_match_device_colour", "crates/preflight/src/tests.rs::xmp_simple_values_have_their_lexical_forms", "crates/preflight/src/tests.rs::xmp_arrays_have_their_kind_and_item_types", "crates/preflight/src/tests.rs::xmp_structures_have_their_field_types", "crates/preflight/src/tests.rs::xmp_value_types_are_reported_by_verify", "crates/preflight/src/tests.rs::xmp_exif_schemas_have_their_value_types", "crates/preflight/src/tests.rs::xmp_exif_properties_are_known_by_namespace_uri", "crates/automation/tests/it/automation.rs::pdfa_through_tools", "crates/ui-egui/tests/it/compare.rs::pdfa_dialog_verifies_and_converts"]
|
||||
notes = "PDF/A-2b/3b structural rules: identification, the value types of the predefined XMP schemas (6.6.2.3.1: dc, xmp, xmpRights, xmpMM, xmpBJ, xmpTPg, xmpDM, pdf, photoshop, crs, and tiff, exif and aux from the September 2005 XMP Specification, with their structures), encryption, output intent (present, and RGB/CMYK to match DeviceRGB/DeviceCMYK use), fonts embedded, annotations, actions, images, embedded files. Not yet: content-stream operator checks, transparency details, PDF/A-1 and -4, a veraPDF comparison."
|
||||
|
||||
[[feature]]
|
||||
|
||||
Reference in new issue
Block a user