Article technique

Quelles parties PDF/A exigent un schéma d'extension XMP ?

Un numéro de facture ERP ajouté au XMP d'un fichier PDF/A-2b attire un constat de propriété non déclarée, alors que le même paquet dans un fichier PDF/A-4 est conforme. Les parties 1 à 3 exigent une description pdfaExtension:schemas pour chaque propriété personnalisée et la partie 4 non, si bien que le validateur PDF/A de PDFium Component pour Delphi lit pdfaid:part avant de choisir un jeu de règles

Flux de décision de PDFium Component pour Delphi lisant pdfaid:part pour choisir les contrôles d'extension schema sous les parties PDF/A 1 à 3 et les règles au niveau du paquet sous PDF/A-4
le validateur lit pdfaid:part d'abord, si bien qu'un paquet revendiquant la partie 4 esquive les quatre constats d'extension schema que les parties 1 à 3 relèvent dans PDFium Component pour Delphi

Que les parties PDF/A 1 à 3 exigent-elles d'une propriété personnalisée ?

Une description de son espace de noms, plus une ligne dans cette description qui nomme la propriété. L'ISO 19005-1 §6.7.2 n'autorise les propriétés XMP que depuis les schémas prédéfinis ou depuis des schémas d'extension conformes au §6.7.8, qui veut chaque description dans le même flux de métadonnées ; l'ISO 19005-2 §6.6.2.3.1 transporte la règle dans les parties 2 et 3. Une description n'est pas un permis général. Elle nomme les propriétés une par une via pdfaProperty:name, si bien qu'un paquet qui décrit inv:InvoiceNumber et écrit aussi inv:DueDate échoue sur la seconde. PDFium Component rapporte ces cas sous quatre valeurs TPdfAValidationIssue, un constat par faute : un préfixe renommé ne donne, par exemple, que le constat de préfixe

Valeur d'issueRapportée quandClause
pvaiMissingExtensionSchemaUn espace de noms non prédéfini est en usage et le paquet n'a aucun conteneur pdfaExtension:schemas19005-1 §6.7.8, 19005-2 §6.6.2.3.1
pvaiXmpPropertyUndeclaredLe conteneur existe mais aucune description dedans ne nomme la propriété19005-1 §6.7.2, 19005-2 §6.6.2.3.1
pvaiExtensionSchemaPrefixUn espace de noms de description est lié à un préfixe autre que le requis19005-1 §6.7.8, 19005-2 §6.6.2.3.2
pvaiExtensionSchemaEntryMissingUne description laisse de côté un champ que sa table liste19005-1 §6.7.8, 19005-2 §6.6.2.3.3

Laquelle des deux premières vous tombez dessus dépend du producteur. Bien des writers PDF/A décrivent déjà le schéma d'identification pdfaid dans un conteneur, SaveAsPdfA de PDFium Component compris, si bien qu'un champ ajouté plus tard atterrit à côté d'un conteneur qui n'a aucune entrée pour lui. La routine ci-dessous n'imprime que les constats d'extension schema. Attendu : un fichier PDF/A-2b écrit par SaveAsPdfA imprime pac2b et pvaiXmpPropertyUndeclared, un paquet de partie 1 ou 2 sans conteneur imprime pvaiMissingExtensionSchema, et un fichier PDF/A-4 n'imprime que sa ligne de conformité

uses
  System.SysUtils, System.Classes, System.TypInfo,
  PDFium, FPdfPdfa, FPdfXmp;

const
  InvoiceNs = 'http://ns.example.com/invoice/1.0/';
  ExtensionIssues: TPdfAValidationIssues = [pvaiMissingExtensionSchema,
    pvaiXmpPropertyUndeclared, pvaiExtensionSchemaPrefix,
    pvaiExtensionSchemaEntryMissing];

procedure PrintExtensionIssues(Source: TStream);
var
  Res: TPdfAValidationResult;
  Issue: TPdfAValidationIssue;
begin
  Res := ValidatePdfAComplianceEx(Source, TPdfAValidationOptions.Default);
  Writeln(GetEnumName(TypeInfo(TPdfAConformance), Ord(Res.Conformance)));
  for Issue in Res.Issues * ExtensionIssues do
    Writeln('  ', GetEnumName(TypeInfo(TPdfAValidationIssue), Ord(Issue)));
end;

procedure ProbeCustomProperty(const FileName: string);
var
  Pdf: TPdf;
  Packet: TPdfXmpPacket;
  Output: TMemoryStream;
begin
  Output := TMemoryStream.Create;
  try
    Pdf := TPdf.Create(nil);
    try
      Pdf.FileName := FileName;
      Pdf.Active := True;
      Packet := Pdf.ReadXmpPacket;
      if Packet = nil then
        raise Exception.CreateFmt('%s has no XMP packet', [FileName]);
      try
        Packet.SetSimpleValue(InvoiceNs, 'inv', 'InvoiceNumber', 'INV-2026-0412');
        if not Pdf.SaveAsWithXmpPacket(Output, Packet) then
          raise Exception.Create('Saving the edited packet failed');
      finally
        Packet.Free;
      end;
    finally
      Pdf.Free;
    end;
    Output.Position := 0;
    PrintExtensionIssues(Output);
  finally
    Output.Free;
  end;
end;

L'ensemble prédéfini a bougé entre XMP 2004 et ISO 16684-1

La partie 1 et la partie 2 ne s'accordent pas sur ce que prédéfini veut dire. L'ISO 19005-1 §6.7.2 pointe la XMP Specification de janvier 2004, l'ISO 19005-2 §6.6.2.3.1 pointe l'ISO 16684-1, dont la liste est plus longue. L'écart se montre dans les fichiers de tous les jours via crs (réglages Camera Raw), aux (données EXIF additionnelles) et xmpDM (médias dynamiques), que la TechNote 0008 du PDF/A Competence Center note en bas de page comme nouveaux dans la spécification XMP 2005. Une propriété crs:AutoBrightness ou xmpDM:videoColorSpace réclame une description sous la partie 1 et est prédéfinie à partir de la partie 2. Le corpus public veraPDF possède des fichiers d'échec PDF/A-1b qui ajoutent une telle propriété et rien d'autre, tandis que le constructeur de fichiers de test de veraPDF lui-même écrit une astuce camera-raw ou média dynamique dans ses fichiers PDF/A-2b, si bien qu'un contrôleur aveugle au numéro de partie se trompe d'un côté. Les déclarations ont bougé aussi : photoshop:SupplementalCategories est Text en 2004 et un bag de Text dans l'ISO 16684-1, si bien que la forme bag échoue en PDF/A-1 et est correcte en PDF/A-2

Le raccourci inverse échoue aussi. Traiter tout ce qui est hors des dix tables de schémas de la TechNote 0008 comme une extension signalerait les structures sType et l'espace de noms de qualificateur Identifier qu'emploient les entrées xmpMM:History ordinaires, et la TechNote 0008 autorise ces URI en PDF/A-1. PDFium Component lit la partie depuis pdfaid:part : un paquet de partie 1 sans bloc de description qui emploie crs, aux ou xmpDM reçoit pvaiMissingExtensionSchema, un paquet de partie 2 ne reçoit aucun constat d'extension schema. Pour une sortie PDF/A-1, retirez les propriétés camera-raw et médias dynamiques que personne en aval ne lit. Une description crs complète court jusqu'à des dizaines d'entrées, chacune une occasion de constat d'entrée manquante

Préfixes requis et # final dans les URI de schémas

Les espaces de noms XML laissent normalement un writer choisir n'importe quel préfixe. Le §6.7.8 retire cette liberté pour le vocabulaire de description, donnant à chaque structure une URI et un préfixe requis : pdfaSchema, pdfaProperty, pdfaType pour un type de valeur et pdfaField pour un champ de l'un ; l'ISO 19005-2 §6.6.2.3.2 reformule les quatre. Lier http://www.aiim.org/pdfa/ns/property# à nonpdfaProperty est un XML équivalent et échoue quand même, et les fichiers du corpus veraPDF pour cette clause gardent chaque URI correcte et renomment un préfixe. Votre propre schéma est une autre affaire : pdfaSchema:prefix note un préfixe préféré, si bien que inv est une recommandation. Gardez-le égal au préfixe que le paquet lie de toute façon

Anatomie des quatre vocabulaires d'extension schema PDF/A montrant préfixes requis, URI de schémas et champs obligatoires, avec la normalisation du dièse final que PDFium Component applique en Delphi
chaque vocabulaire de description transporte une URI et un préfixe requis, et le composant retire un # final des deux côtés avant de comparer les URI d'espaces de noms

Les URI ont une bizarrerie. La prose de l'ISO 19005-1 §6.7.8 imprime http://www.aiim.org/pdfa/ns/schema sans # final, tandis que ses tables et les fichiers conformes terminent l'URI par un, si bien qu'une comparaison stricte contre la prose ne trouve rien. PDFium Component retire un # final des deux côtés avant de comparer. Écrivez la forme avec #, et copiez votre propre espace de noms dans pdfaSchema:namespaceURI caractère pour caractère. La phrase de clôture de l'ISO 19005-2 §6.6.2.3.2 réclame ensuite chaque champ que les tables du §6.6.2.3.3 listent, et un manque est rapporté comme pvaiExtensionSchemaEntryMissing :

  • Schema (pdfaSchema) : schema, namespaceURI et prefix, plus les listes property et valueType, qu'un schéma sans rien à déclarer peut omettre
  • Property (pdfaProperty) : name, valueType, category et description, où category vaut internal ou external
  • Value type (pdfaType) : type, namespaceURI, prefix, description et field, requis car un type de valeur personnalisé est une structure
  • Field (pdfaField) : name, valueType et description

Comment orthographier une entrée structurée en RDF/XML ?

De trois façons, tant que l'élément reste une structure. L'ISO 32000-2 §14.3.2 confie la grammaire d'un flux de métadonnées à l'ISO 16684-1, qui écrit le XMP comme un sous-ensemble de RDF/XML. La forme courte pose rdf:parseType="Resource" sur le rdf:li et liste les champs dessous ; la forme longue les enveloppe dans un rdf:Description imbriqué, et les deux veulent dire la même structure anonyme. Une troisième orthographe déplace les champs de texte simple en attributs sur ce rdf:Description. Seul le texte y tient : pdfaSchema:property porte une séquence et reste un élément. Retirez rdf:parseType d'un élément en forme courte et le résultat n'est pas du RDF/XML. Un parser attend alors du texte ou un unique élément nœud dans le rdf:li, prend pdfaSchema:schema pour un nœud typé, et un élément nœud ne peut pas porter de texte non blanc, si bien que le premier champ casse déjà la grammaire. Une XSLT qui reconstruit les éléments de liste, ou un gabarit qui régénère le bloc depuis un dictionnaire, peut laisser tomber l'attribut en gardant chaque élément. Relisez une telle sortie avec un parser RDF différent de celui qui l'a écrite pour voir le dégât

Trois orthographes RDF/XML légales d'une entrée d'extension schema PDF/A, et la rupture de grammaire quand rdf:parseType est retiré, telles que PDFium Component les préserve en Delphi
forme courte, forme longue et raccourci par attributs décrivent tous la même structure, et retirer rdf:parseType d'un élément en forme courte casse la grammaire RDF au premier champ
<!-- Forme courte : le schéma facture décrit en entier -->
<rdf:li rdf:parseType="Resource">
  <pdfaSchema:schema>Invoice data from the ERP</pdfaSchema:schema>
  <pdfaSchema:namespaceURI>http://ns.example.com/invoice/1.0/</pdfaSchema:namespaceURI>
  <pdfaSchema:prefix>inv</pdfaSchema:prefix>
  <pdfaSchema:property>
    <rdf:Seq>
      <rdf:li rdf:parseType="Resource">
        <pdfaProperty:name>InvoiceNumber</pdfaProperty:name>
        <pdfaProperty:valueType>Text</pdfaProperty:valueType>
        <pdfaProperty:category>external</pdfaProperty:category>
        <pdfaProperty:description>Invoice number assigned by the ERP</pdfaProperty:description>
      </rdf:li>
    </rdf:Seq>
  </pdfaSchema:property>
</rdf:li>

<!-- Forme longue : la même structure en nœud imbriqué -->
<rdf:li>
  <rdf:Description>
    <pdfaSchema:schema>Invoice data from the ERP</pdfaSchema:schema>
    ...
  </rdf:Description>
</rdf:li>

<!-- Raccourci par attributs : champs de texte en attributs, la liste reste un élément -->
<rdf:li>
  <rdf:Description pdfaSchema:schema="Invoice data from the ERP"
      pdfaSchema:namespaceURI="http://ns.example.com/invoice/1.0/"
      pdfaSchema:prefix="inv">
    <pdfaSchema:property>...</pdfaSchema:property>
  </rdf:Description>
</rdf:li>

PDFium Component garde l'orthographe arrivée. Chaque valeur dans le TPdfXmpPacket que TPdf.ReadXmpPacket renvoie note le rdf:parseType de son élément source, Resource, Literal ou Collection, et ToXml le réécrit ; une structure sans note repart avec rdf:parseType="Resource". Ce writer sert SaveAsWithXmpPacket et NormalizePdfAMetadata, l'appel qui aligne les entrées Info et leurs équivalents XMP, et un bloc d'extension dans l'une ou l'autre des trois orthographes se valide pareil avant et après un cycle de lecture-enregistrement. Écrivez les nouvelles entrées en forme courte. Chaque champ reste un élément, ce qui garde les éditions uniformes, et cela colle à l'entrée pdfaid qu'écrit SaveAsPdfA

Ajouter votre description au conteneur déjà présent

Fusionnez la nouvelle entrée dans le rdf:Bag existant. Un conteneur par paquet. Le parser XMP de veraPDF refuse un paquet avec un second élément pdfaExtension:schemas (Duplicate property or field node 'pdfaExtension:schemas'), et les échecs atterrissent sur les règles générales de métadonnées. Chaque propriété réclame un nom, un type de valeur, une catégorie et une description, les entrées qu'une facture Factur-X remplit pour déclarer ses propriétés fx dans un schéma d'extension. Le listing greffe un élément en forme courte avant </rdf:Bag>, que ToXml écrit sur la ligne propre du conteneur. L'élément déclare pdfaSchema et pdfaProperty lui-même, si bien qu'il se parse pareil où qu'il atterrisse

const
  ExtensionNs = 'http://www.aiim.org/pdfa/ns/extension/';
  ContainerEnd = '</rdf:Bag></pdfaExtension:schemas>';
  TopDescriptionEnd = '</rdf:Description>'#10' </rdf:RDF>';

function InvoiceSchemaItem: string;
begin
  Result := '<rdf:li rdf:parseType="Resource"' +
    ' xmlns:pdfaSchema="http://www.aiim.org/pdfa/ns/schema#"' +
    ' xmlns:pdfaProperty="http://www.aiim.org/pdfa/ns/property#">' +
    '<pdfaSchema:schema>Invoice data from the ERP</pdfaSchema:schema>' +
    '<pdfaSchema:namespaceURI>' + InvoiceNs + '</pdfaSchema:namespaceURI>' +
    '<pdfaSchema:prefix>inv</pdfaSchema:prefix>' +
    '<pdfaSchema:property><rdf:Seq><rdf:li rdf:parseType="Resource">' +
    '<pdfaProperty:name>InvoiceNumber</pdfaProperty:name>' +
    '<pdfaProperty:valueType>Text</pdfaProperty:valueType>' +
    '<pdfaProperty:category>external</pdfaProperty:category>' +
    '<pdfaProperty:description>Invoice number assigned by the ERP' +
    '</pdfaProperty:description>' +
    '</rdf:li></rdf:Seq></pdfaSchema:property></rdf:li>';
end;

// Vrai quand une entrée de schéma décrit Uri, quelle qu'en soit l'orthographe
function DescribesNamespace(const V: TPdfXmpValue; const Uri: string): Boolean;
var
  Q: Integer;
begin
  for Q := 0 to High(V.Qualifiers) do      // champs en attributs sur rdf:li
    if (V.Qualifiers[Q].Name = 'namespaceURI') and
       (string(V.Qualifiers[Q].Value) = Uri) then
      Exit(True);
  Result := (Pos('>' + Uri + '</', string(V.RawXml)) > 0) or    // éléments
    (Pos('namespaceURI="' + Uri + '"', string(V.RawXml)) > 0);   // attributs
end;

// Renvoie un nouveau paquet ; l'appelant le libère
function WithInvoiceSchema(Packet: TPdfXmpPacket): TPdfXmpPacket;
var
  Xml: string;
  Index, J, P: Integer;
  HasContainer: Boolean;
begin
  HasContainer := Packet.TryGetProperty(ExtensionNs, 'schemas', Index);
  if HasContainer then
    for J := 0 to High(Packet.Properties[Index].Values) do
      if DescribesNamespace(Packet.Properties[Index].Values[J], InvoiceNs) then
        Exit(Packet.Clone);                // déjà décrit
  Xml := Packet.ToXml;
  P := Pos(ContainerEnd, Xml);
  if P > 0 then
    Insert(InvoiceSchemaItem, Xml, P)      // rejoint le bag existant
  else if HasContainer then
    raise EPdfXmpError.Create('Extension container uses an unexpected prefix')
  else
  begin
    P := Pos(TopDescriptionEnd, Xml);
    if P = 0 then
      raise EPdfXmpError.Create('Unexpected XMP packet layout');
    Insert('<pdfaExtension:schemas xmlns:pdfaExtension="' + ExtensionNs +
      '"><rdf:Bag>' + InvoiceSchemaItem + ContainerEnd + #10'  ', Xml, P);
  end;
  Result := TPdfXmpPacket.Parse(Xml);
end;

procedure TagInvoice(const SourceFile, TargetFile, InvoiceNo: string);
var
  Pdf: TPdf;
  Packet, Described: TPdfXmpPacket;
  Written: TFileStream;
begin
  Pdf := TPdf.Create(nil);
  try
    Pdf.FileName := SourceFile;
    Pdf.Active := True;
    Packet := Pdf.ReadXmpPacket;
    if Packet = nil then
      raise Exception.CreateFmt('%s has no XMP packet', [SourceFile]);
    Described := nil;
    try
      Packet.SetSimpleValue(InvoiceNs, 'inv', 'InvoiceNumber', InvoiceNo);
      Described := WithInvoiceSchema(Packet);
      if not Pdf.SaveAsWithXmpPacket(TargetFile, Described) then
        raise Exception.CreateFmt('Could not write %s', [TargetFile]);
    finally
      Described.Free;
      Packet.Free;
    end;
  finally
    Pdf.Free;
  end;
  Written := TFileStream.Create(TargetFile, fmOpenRead or fmShareDenyWrite);
  try
    PrintExtensionIssues(Written);         // depuis le premier listing
  finally
    Written.Free;
  end;
end;

Attendu : pour une source PDF/A-1, -2 ou -3 écrite par SaveAsPdfA, TagInvoice imprime la ligne de conformité et aucune des quatre valeurs d'extension schema, avec l'entrée facture en forme courte à côté de celle en pdfaid. Un second passage laisse le bag tranquille quelle que soit l'orthographe de l'entrée existante : DescribesNamespace fouille RawXml et, pour les attributs sur un rdf:li vide, les qualificateurs. Un conteneur sous un autre préfixe lève une exception, car un neuf serait le doublon que veraPDF refuse. Quand l'ERP ajoute une échéance, étendez la séquence pdfaSchema:property existante

PDF/A-4 vérifie-t-il du tout les schémas d'extension ?

Non. L'ISO 19005-4 §6.7.2.1 ne garde que des règles au niveau du paquet : la clé Metadata du catalog, les attributs d'en-tête obsolètes bytes et encoding, le XML bien formé et l'UTF-8. Une propriété non décrite, une description sous nonpdfaSchema et une sans pdfaSchema:schema laissent toutes un fichier conforme sous le profil veraPDF PDF/A-4, et PDFium Component ne lance ses quatre contrôles d'extension schema que quand pdfaid:part vaut 1, 2 ou 3. Le schéma d'identification garde ses règles partout. Sous le §6.7.3 de la partie 4, son espace de noms doit toujours être lié à pdfaid, et son jeu de propriétés grossit par partie : part, conformance et, depuis l'Amendement 1 de 2007, amd en partie 1, corr à partir de l'ISO 19005-2 §6.6.4, rev en partie 4. Un préfixe faux est rapporté comme pvaiXmpIdPrefixWrong et un nom en trop comme pvaiXmpIdPropertyUnknown dans chaque partie

Pour comparer des parties sur un même document, changez le paquet et rien d'autre : insérez la liaison d'espace de noms dans le XMP et supprimez autant d'octets de blancs entre les balises, si bien que /Length, les offsets de la table de références croisées et le header %PDF-2.0 restent en place. Une réécriture pypdf peut rendre un fichier PDF/A-4 avec un header %PDF-1.3 dont les échecs ensevelissent le résultat des métadonnées. Pour une sortie de production, écrivez la description dans les paquets PDF/A-4 aussi : elle coûte quelques centaines d'octets, le validateur de PDFium Component la laisse tranquille sous la partie 4, et le paquet peut plus tard passer dans un livrable PDF/A-3 inchangé