Artykuł techniczny

Które części PDF/A wymagają schematu rozszerzenia XMP?

Numer faktury z ERP dodany do XMP pliku PDF/A-2b ściągna uwagę o niezadeklarowanej właściwości, a ten sam pakiet w pliku PDF/A-4 jest zgodny. Części 1–3 wymagają opisu pdfaExtension:schemas dla każdej własnej właściwości, a część 4 nie, więc walidator PDF/A w PDFium Component dla Delphi czyta pdfaid:part, zanim wybierze zestaw reguł

Przepływ decyzyjny PDFium Component dla Delphi czytającego pdfaid:part, by wybrać kontrole schematów rozszerzenia pod częściami PDF/A 1–3 i reguły na poziomie pakietu pod PDF/A-4
Walidator najpierw czyta pdfaid:part, więc pakiet deklarujący część 4 omija cztery uwagi schematów rozszerzenia, które części 1–3 podnoszą w PDFium Component dla Delphi

Czego części PDF/A 1–3 wymagają od własnej właściwości?

Opis jej przestrzeni nazw plus wiersz w tym opisie wymieniający właściwość. ISO 19005-1 §6.7.2 dopuszcza właściwości XMP tylko ze schematów predefiniowanych albo ze schematów rozszerzenia zgodnych z §6.7.8, który żąda każdego opisu w tym samym strumieniu metadanych; ISO 19005-2 §6.6.2.3.1 niesie regułę do części 2 i 3. Opis to nie blankiet na wszystko. Wymienia właściwości po kolei przez pdfaProperty:name, więc pakiet opisujący inv:InvoiceNumber, a piszący też inv:DueDate, obala się na tej drugiej. PDFium Component raportuje te przypadki pod czterema wartościami TPdfAValidationIssue, jedna uwaga na winę: zmieniony prefiks daje na przykład samą uwagę o prefiksie

Wartość uwagiRaportowana, gdyKlauzula
pvaiMissingExtensionSchemaUżywana jest niepredefiniowana przestrzeń nazw, a pakiet nie ma kontenera pdfaExtension:schemas19005-1 §6.7.8, 19005-2 §6.6.2.3.1
pvaiXmpPropertyUndeclaredKontener istnieje, ale żaden opis w nim nie wymienia właściwości19005-1 §6.7.2, 19005-2 §6.6.2.3.1
pvaiExtensionSchemaPrefixPrzestrzeń nazw opisu związana jest z prefiksem innym niż wymagany19005-1 §6.7.8, 19005-2 §6.6.2.3.2
pvaiExtensionSchemaEntryMissingOpis pomija pole, które wymienia jego tabela19005-1 §6.7.8, 19005-2 §6.6.2.3.3

Którą z pierwszych dwóch dostaniesz, zależy od producenta. Wiele pisarzy PDF/A opisuje już schemat identyfikacji pdfaid w kontenerze, w tym SaveAsPdfA w PDFium Component, więc pole dodane później ląduje obok kontenera, który nie ma na nie wpisu. Poniższa procedura drukuje wyłącznie uwagi schematów rozszerzenia. Oczekiwane: plik PDF/A-2b zapisany przez SaveAsPdfA drukuje pac2b i pvaiXmpPropertyUndeclared, pakiet części 1 albo 2 bez kontenera drukuje pvaiMissingExtensionSchema, a plik PDF/A-4 drukuje sam swój wiersz zgodności

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;

Zestaw predefiniowany przesunął się między XMP 2004 a ISO 16684-1

Część 1 i część 2 nie zgadzają się, co znaczy predefiniowany. ISO 19005-1 §6.7.2 wskazuje na specyfikację XMP ze stycznia 2004, ISO 19005-2 §6.6.2.3.1 na ISO 16684-1, której lista jest dłuższa. Przepaść wychodzi na jaw w codziennych plikach przez crs (ustawienia Camera Raw), aux (dodatkowe dane EXIF) i xmpDM (media dynamiczne), które TechNote 0008 PDF/A Competence Center przypisuje w przypisie jako nowe w specyfikacji XMP 2005. Właściwość crs:AutoBrightness albo xmpDM:videoColorSpace potrzebuje opisu pod częścią 1 i jest predefiniowana od części 2 wzwyż. Publiczny korpus veraPDF ma pliki niepowodzeń PDF/A-1b, które dodają jedną taką właściwość i nic poza tym, podczas gdy własny konstruktor plików testowych veraPDF wpisuje do swoich plików PDF/A-2b podpowiedź camera-raw albo dynamic-media, więc kontroler ślepy na numer części myli się po jednej ze stron. Deklaracje też się przesunęły: photoshop:SupplementalCategories to Text w 2004 i bag Textów w ISO 16684-1, więc forma bag obala PDF/A-1 i jest poprawna w PDF/A-2

Przeciwne skróty też zawodzą. Nazwanie wszystkim poza dziesięcioma tabelami schematów TechNote 0008 rozszerzeniem oflagowałoby struktury sType i przestrzeń nazw kwalifikatora Identifier, których używają zwykłe wpisy xmpMM:History, a TechNote 0008 pozwala te URI w PDF/A-1. PDFium Component czyta część z pdfaid:part: pakiet części 1 bez bloku opisu, który używa crs, aux albo xmpDM, dostaje pvaiMissingExtensionSchema, pakiet części 2 nie dostaje żadnej uwagi o schematach rozszerzenia. Dla wyjścia PDF/A-1 wytnij właściwości camera-raw i dynamic-media, których nikt downstream nie czyta. Pełny opis crs rośnie do dziesiątek wpisów, z których każdy to szansa na uwagę o brakującym wpisie

Wymagane prefiksy i końcowy # w URI schematów

Przestrzenie nazw XML normalnie pozwalają pisarzowi wybrać dowolny prefiks. §6.7.8 odbiera tę swobodę dla słownictwa opisów, dając każdej strukturze URI i wymagany prefiks: pdfaSchema, pdfaProperty, pdfaType dla typu wartości i pdfaField dla pola jednej; ISO 19005-2 §6.6.2.3.2 powtarza wszystkie cztery. Związanie http://www.aiim.org/pdfa/ns/property# z nonpdfaProperty to równoważny XML i mimo to obala, a pliki korpusu veraPDF dla tej klauzuli trzymają każdy URI poprawny i przemianowują jeden prefiks. Twój własny schemat to inna sprawa: pdfaSchema:prefix odnotowuje preferowany prefiks, więc inv to rekomendacja. I tak trzymaj go równym prefiksowi, który wiąże pakiet

Anatomia czterech słowników schematów rozszerzenia PDF/A pokazująca wymagane prefiksy, URI schematów i obowiązkowe pola, z normalizacją końcowego krzyżyka, którą PDFium Component stosuje w Delphi
Każdy słownik opisów niesie URI i wymagany prefiks, a komponent zrzuca końcowy # po obu stronach przed porównaniem URI przestrzeni nazw

URI mają quirk. Proza ISO 19005-1 §6.7.8 drukuje http://www.aiim.org/pdfa/ns/schema bez końcowego #, podczas gdy jej tabele i pliki zgodne kończą URI jednym, więc ścisłe porównanie z prozą nie łapie niczego. PDFium Component zrzuca końcowy # po obu stronach przed porównaniem. Pisz formę z # i przepisuj własną przestrzeń nazw do pdfaSchema:namespaceURI znak po znaku. Zamykające zdanie ISO 19005-2 §6.6.2.3.2 żąda potem każdego pola, które wymieniają tabele §6.6.2.3.3, a luka jest raportowana jako pvaiExtensionSchemaEntryMissing:

  • Schema (pdfaSchema): schema, namespaceURI i prefix, plus listy property i valueType, które schemat bez niczego do zadeklarowania może pominąć
  • Property (pdfaProperty): name, valueType, category i description, gdzie category to internal albo external
  • Value type (pdfaType): type, namespaceURI, prefix, description i field, wymagane, bo własny typ wartości to struktura
  • Field (pdfaField): name, valueType i description

Jak zapisywać ustrukturyzowany wpis w RDF/XML?

Dowolnym z trzech sposobów, o ile wpis pozostaje strukturą. ISO 32000-2 §14.3.2 oddaje gramatykę strumienia metadanych ISO 16684-1, która zapisuje XMP jako podzbiór RDF/XML. Forma krótka kładzie rdf:parseType="Resource" na rdf:li i wylicza pola pod nim; forma długa owija je w zagnieżdżony rdf:Description, i obie znaczą tę samą anonimową strukturę. Trzecia pisownia przenosi pola czystego tekstu do atrybutów na tym rdf:Description. Pasuje tam tylko tekst: pdfaSchema:property trzyma sekwencję i zostaje elementem. Zerwij rdf:parseType z wpisu formy krótkiej, a wynik to nie RDF/XML. Parser oczekuje wtedy tekstu albo jednego elementu węzła wewnątrz rdf:li, bierze pdfaSchema:schema za węzeł typowany, a element węzła nie może trzymać tekstu poza białymi znakami, więc pierwsze pole już łamie gramatykę. XSLT przebudowujące wpisy listy albo szablon regenerujący blok ze słownika może zrzucić atrybut, trzymając każdy element. Przeczytaj takie wyjście z powrotem innym parserem RDF niż ten, który je napisał, żeby zobaczyć szkody

Trzy legalne pisownie RDF/XML jednego wpisu schematu rozszerzenia PDF/A i złamanie gramatyki przy zerwaniu rdf:parseType, tak jak PDFium Component je zachowuje w Delphi
Forma krótka, długa i skrót atrybutowy opisują tę samą strukturę, a zerwanie rdf:parseType z wpisu formy krótkiej łamie gramatykę RDF na pierwszym polu
<!-- Forma krótka: schemat faktury opisany w całości -->
<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>

<!-- Forma długa: ta sama struktura jako zagnieżdżony węzeł -->
<rdf:li>
  <rdf:Description>
    <pdfaSchema:schema>Invoice data from the ERP</pdfaSchema:schema>
    ...
  </rdf:Description>
</rdf:li>

<!-- Skrót atrybutowy: pola tekstowe jako atrybuty, lista zostaje elementem -->
<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 trzyma pisownię, jaka przyszła. Każda wartość w TPdfXmpPacket, który zwraca TPdf.ReadXmpPacket, odnotowuje rdf:parseType swojego elementu źródłowego, Resource, Literal albo Collection, a ToXml zapisuje go z powrotem; struktura bez odnotowania wychodzi z rdf:parseType="Resource". Ten pisarz obsługuje SaveAsWithXmpPacket i NormalizePdfAMetadata, wołanie doprowadzające wpisy Info i ich odpowiedniki XMP do porządku, i blok rozszerzenia w dowolnej z trzech pisowni waliduje się tak samo przed i po cyklu odczytu i zapisu. Nowe wpisy pisz formą krótką. Każde pole zostaje elementem, co trzyma edycje jednolite, i zgadza się z wpisem pdfaid, który zapisuje SaveAsPdfA

Dokładanie twojego opisu do kontenera, który już tam jest

Wpleć nowy wpis w istniejący rdf:Bag. Jeden kontener na pakiet. Parser XMP veraPDF odmawia pakietu z drugim elementem pdfaExtension:schemas (Duplicate property or field node 'pdfaExtension:schemas'), a niepowodzenia lądują na ogólnych regułach metadanych. Każda właściwość potrzebuje nazwy, typu wartości, kategorii i opisu, wpisów, które faktura Factur-X wypełnia, żeby zadeklarować swoje właściwości fx w schemacie rozszerzenia. Listing wplata wpis formy krótkiej przed </rdf:Bag>, który ToXml zapisuje na osobnym wierszu kontenera. Wpis deklaruje pdfaSchema i pdfaProperty sam w sobie, więc parsuje się tak samo, gdziekolwiek ląduje

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;

// True, gdy wpis schematu opisuje Uri, w dowolnej użytej pisowni
function DescribesNamespace(const V: TPdfXmpValue; const Uri: string): Boolean;
var
  Q: Integer;
begin
  for Q := 0 to High(V.Qualifiers) do      // pola jako atrybuty na 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    // elementy
    (Pos('namespaceURI="' + Uri + '"', string(V.RawXml)) > 0);   // atrybuty
end;

// Zwraca nowy pakiet; wołający go zwalnia
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);                // już opisany
  Xml := Packet.ToXml;
  P := Pos(ContainerEnd, Xml);
  if P > 0 then
    Insert(InvoiceSchemaItem, Xml, P)      // dołącz do istniejącego baga
  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);         // z pierwszego listingu
  finally
    Written.Free;
  end;
end;

Oczekiwane: dla źródła PDF/A-1, -2 albo -3 zapisanego przez SaveAsPdfA TagInvoice drukuje wiersz zgodności i żadną z czterech wartości schematów rozszerzenia, z wpisem faktury formy krótkiej obok wpisu pdfaid. Drugi przebieg zostawia baga w spokoju w każdej pisowni istniejącego wpisu: DescribesNamespace szuka w RawXml i, dla atrybutów na pustym rdf:li, w kwalifikatorach. Kontener pod innym prefiksem podnosi wyjątek, bo świeży byłby duplikatem, którego veraPDF odmawia. Kiedy ERP doda termin płatności, rozszerz istniejącą sekwencję pdfaSchema:property

Czy PDF/A-4 w ogóle sprawdza schematy rozszerzenia?

Nie. ISO 19005-4 §6.7.2.1 trzyma tylko reguły na poziomie pakietu: klucz Metadata katalogu, przestarzałe atrybuty nagłówka bytes i encoding, poprawnie zbudowany XML i UTF-8. Niezadeklarowana właściwość, opis pod nonpdfaSchema i opis bez pdfaSchema:schema wszystkie zostawiają plik zgodny pod profilem veraPDF PDF/A-4, a PDFium Component odpala swoje cztery kontrole schematów rozszerzenia tylko, gdy pdfaid:part to 1, 2 albo 3. Schemat identyfikacji trzyma swoje reguły wszędzie. Pod §6.7.3 części 4 jego przestrzeń nazw nadal musi być związana z pdfaid, a jego zestaw właściwości rośnie z częścią: part, conformance i, od Poprawki 1 z 2007, amd w części 1, corr od ISO 19005-2 §6.6.4 wzwyż, rev w części 4. Zły prefiks jest raportowany jako pvaiXmpIdPrefixWrong, a nadmiarowa nazwa jako pvaiXmpIdPropertyUnknown w każdej części

Żeby porównać części na jednym dokumencie, zmień pakiet i nic poza nim: wstaw wiązanie przestrzeni nazw wewnątrz XMP i skasuj tyle bajtów białych znaków między tagami, żeby /Length, offsety tablicy odwołań i nagłówek %PDF-2.0 zostały na miejscu. Przepisanka pypdf potrafi oddać plik PDF/A-4 z nagłówkiem %PDF-1.3, którego niepowodzenia zakopią wynik metadanych. Dla wyjścia produkcyjnego zapisuj opis także w pakietach PDF/A-4: kosztuje paręset bajtów, walidator w PDFium Component zostawia go w spokoju pod częścią 4, a pakiet może później przejść do dostawy PDF/A-3 bez zmian