技術記事

どの PDF/A パートに XMP 拡張スキーマが要るか

PDF/A-2b ファイルの XMP に足した ERP の請求書番号は、宣言されていないプロパティという指摘を引きます。同じパケットでも PDF/A-4 ファイルでは適合です。パート 1 から 3 はすべてのカスタムプロパティに pdfaExtension:schemas の記述を要求し、パート 4 は要求しないので、Delphi 用 PDFium Component の PDF/A バリデータは、規則の集合を選ぶ前に pdfaid:part を読みます

Delphi 用 PDFium Component が pdfaid:part を読んで、PDF/A パート 1 から 3 では拡張スキーマ検査を、PDF/A-4 ではパケットレベルの規則を選ぶ判断フロー
バリデータは最初に pdfaid:part を読むので、パート 4 を名乗るパケットは、パート 1 から 3 で PDFium Component が上げる 4 つの拡張スキーマ指摘を回避します

PDF/A パート 1 から 3 はカスタムプロパティに何を要求するか

その名前空間の記述、そしてその記述の中でプロパティを名指す 1 行です。ISO 19005-1 の §6.7.2 は XMP プロパティを、事前定義のスキーマか、§6.7.8 に適合する拡張スキーマからだけ認めます。§6.7.8 は各記述を同じメタデータストリームに入れるよう求めます。ISO 19005-2 の §6.6.2.3.1 がこの規則をパート 2 と 3 に運びます。記述は包括的な許可ではありません。プロパティは pdfaProperty:name で 1 個ずつ名指されるので、inv:InvoiceNumber を記述したパケットが inv:DueDate も書けば、2 つ目で落ちます。PDFium Component はこうしたケースを 4 つの TPdfAValidationIssue 値で報告し、1 つの欠陥に 1 つの指摘です。接頭辞の改名なら、たとえば、接頭辞の指摘だけが出ます

Issue 値報告される条件条項
pvaiMissingExtensionSchema事前定義でない名前空間が使われていて、パケットに pdfaExtension:schemas コンテナがない19005-1 §6.7.8、19005-2 §6.6.2.3.1
pvaiXmpPropertyUndeclaredコンテナはあるが、その中のどの記述もプロパティを名指さない19005-1 §6.7.2、19005-2 §6.6.2.3.1
pvaiExtensionSchemaPrefix記述の名前空間が必須のもの以外の接頭辞に束縛されている19005-1 §6.7.8、19005-2 §6.6.2.3.2
pvaiExtensionSchemaEntryMissing記述が、その表に列挙されたフィールドを 1 つ欠いている19005-1 §6.7.8、19005-2 §6.6.2.3.3

最初の 2 つのどちらになるかは作成側次第です。多くの PDF/A ライターは、PDFium Component の SaveAsPdfA も含めて、既にコンテナの中で pdfaid の識別スキーマを記述しているので、後から足したフィールドは、自分のエントリを持たないコンテナの隣に着地します。下のルーチンは拡張スキーマの指摘だけを印字します。期待値: SaveAsPdfA が書いた PDF/A-2b ファイルは pac2b と pvaiXmpPropertyUndeclared を印字し、コンテナのないパート 1 か 2 のパケットは pvaiMissingExtensionSchema を、PDF/A-4 ファイルは適合行だけを印字します

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;

事前定義の集合は XMP 2004 と ISO 16684-1 の間で動いた

パート 1 とパート 2 は、事前定義の意味で食い違います。ISO 19005-1 の §6.7.2 は 2004 年 1 月の XMP Specification を指し、ISO 19005-2 の §6.6.2.3.1 は ISO 16684-1 を指し、後者のリストのほうが長いです。この差は日常のファイルに現れます。crs(Camera Raw 設定)、aux(追加 EXIF データ)、xmpDM(ダイナミックメディア)で、PDF/A Competence Center の TechNote 0008 はこれらを XMP 2005 仕様での新顔と脚注にしています。crs:AutoBrightness や xmpDM:videoColorSpace のプロパティは、パート 1 では記述が要り、パート 2 からは事前定義です。公開 veraPDF コーパスには、そういうプロパティを 1 つ足しただけで他は何もしない PDF/A-1b の失敗ファイルがあり、一方 veraPDF 自身のテストファイルビルダーは PDF/A-2b ファイルに camera-raw やダイナミックメディアのヒントを書き込むので、パート番号に盲見なチェッカーはどちらか一方を取り違えます。宣言も動きました。photoshop:SupplementalCategories は 2004 では Text、ISO 16684-1 では Text の bag で、bag 形式は PDF/A-1 では落ちて PDF/A-2 では正しいです

逆の近道も落ちます。TechNote 0008 の 10 個のスキーマ表の外をすべて拡張と呼ぶと、普通の xmpMM:History エントリが使う sType 構造や Identifier 修飾子名前空間を旗立てることになり、TechNote 0008 は PDF/A-1 でそれらの URI を認めています。PDFium Component はパートを pdfaid:part から読みます。記述ブロックを持たないパート 1 のパケットが crs、aux、xmpDM を使っていれば pvaiMissingExtensionSchema、パート 2 のパケットは拡張スキーマの指摘を受けません。PDF/A-1 出力では、下流の誰も読まない camera-raw とダイナミックメディアのプロパティを剥ぎましょう。crs の完全な記述は数十エントリに伸び、1 個ずつが entry-missing 指摘の種です

スキーマ URI の必須接頭辞と末尾の #

XML の名前空間は通常、書き手に任意の接頭辞を許します。§6.7.8 は記述ボキャブラリからその自由を取り上げ、各構造に URI と必須接頭辞を与えます。値型には pdfaSchema、pdfaProperty、pdfaType、その 1 フィールドには pdfaField。ISO 19005-2 の §6.6.2.3.2 は 4 つすべてを再述します。http://www.aiim.org/pdfa/ns/property# を nonpdfaProperty に束縛するのは等価な XML であり、それでも落ちます。この条項の veraPDF コーパスファイルはすべての URI を正しく保ち、接頭辞を 1 つ改名しています。自分のスキーマは別問題です。pdfaSchema:prefix は推奨接頭辞を記録するので、inv は推奨です。とはいえパケットが束縛する接頭辞と同じに保ちましょう

PDF/A の 4 つの拡張スキーマボキャブラリの解剖図。必須接頭辞、スキーマ URI、必須フィールドを示し、Delphi で PDFium Component が適用する末尾ハッシュの正規化を添える
各記述ボキャブラリは URI と必須接頭辞を運び、コンポーネントは名前空間 URI を比較する前に両側の末尾の # を落とします

URI には一癖があります。ISO 19005-1 §6.7.8 の本文は http://www.aiim.org/pdfa/ns/schema を末尾の # なしで印字する一方、その表と適合ファイルは URI を # で終えるので、本文に対する厳密な比較は何も一致させません。PDFium Component は比較の前に両側の末尾の # を落とします。# 形式で書き、自分の名前空間は pdfaSchema:namespaceURI へ 1 文字も変えずにコピーしましょう。ISO 19005-2 §6.6.2.3.2 の締めの文は、§6.6.2.3.3 の表が列挙するすべてのフィールドを求め、欠けは pvaiExtensionSchemaEntryMissing として報告されます:

  • Schema(pdfaSchema): schema、namespaceURI、prefix に加えて property と valueType のリスト。宣言すべきものがないスキーマは省いて構いません
  • Property(pdfaProperty): name、valueType、category、description。category は internal か external です
  • Value type(pdfaType): type、namespaceURI、prefix、description、field。カスタム値型は構造なので必須です
  • Field(pdfaField): name、valueType、description

構造化エントリは RDF/XML でどう綴るべきか

アイテムが構造であり続ける限り、3 通りのどれでも構いません。ISO 32000-2 の §14.3.2 はメタデータストリームの文法を ISO 16684-1 に委ね、XMP は RDF/XML の部分集合として書かれます。短い形式は rdf:parseType="Resource" を rdf:li に置き、フィールドをその下に並べます。長い形式は入れ子の rdf:Description で包み、どちらも同じ無名構造を意味します。3 つ目の綴りは、平文テキストのフィールドをその rdf:Description の属性へ移します。そこに収まるのはテキストだけです。pdfaSchema:property はシーケンスを抱えるので要素のままです。短い形式のアイテムから rdf:parseType を剥ぐと、結果は RDF/XML ではなくなります。パーサーは rdf:li の内側にテキストか 1 つのノード要素を期待し、pdfaSchema:schema を型付きノードと取り、ノード要素は空白でないテキストを持てないので、最初のフィールドで文法が破れます。リストアイテムを再構築する XSLT や、辞書からブロックを再生成するテンプレートは、すべての要素を保ったまま属性を落とせます。そういう出力は、書いたのと別の RDF パーサーで読み返して被害を確認しましょう

1 つの PDF/A 拡張スキーマエントリの 3 つの正しい RDF/XML 綴りと、rdf:parseType を剥いだときの文法破綻。Delphi の PDFium Component はそれらをそのまま保存する
短い形式、長い形式、属性の省略記法はどれも同じ構造を記述します。短い形式のアイテムから rdf:parseType を剥ぐと、最初のフィールドで RDF の文法が破れます
<!-- 短い形式: 完全に記述された請求書スキーマ -->
<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>

<!-- 長い形式: 同じ構造を入れ子ノードとして -->
<rdf:li>
  <rdf:Description>
    <pdfaSchema:schema>Invoice data from the ERP</pdfaSchema:schema>
    ...
  </rdf:Description>
</rdf:li>

<!-- 属性の省略記法: テキストフィールドを属性に、リストは要素のまま -->
<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 は届いた綴りをそのまま保ちます。TPdf.ReadXmpPacket が返す TPdfXmpPacket の各値は、ソース要素の rdf:parseType——Resource、Literal、Collection——を記録し、ToXml はそれを書き戻します。記録のない構造は rdf:parseType="Resource" 付きで出ていきます。このライターは SaveAsWithXmpPacket と、Info エントリとその XMP 等価物を整える NormalizePdfAMetadata に仕え、3 つの綴りのどれで書かれた拡張ブロックも、読み書きの前後で同じように検証を通ります。新しいエントリは短い形式で書きましょう。すべてのフィールドが要素のままになり、編集が均一になるほか、SaveAsPdfA が書く pdfaid エントリとも揃います

既にあるコンテナに自分の記述を加える

新しいエントリを既存の rdf:Bag に合流させましょう。パケットにコンテナは 1 つです。veraPDF の XMP パーサーは、2 つ目の pdfaExtension:schemas 要素を持つパケットを拒みます(Duplicate property or field node 'pdfaExtension:schemas')。失敗は一般的なメタデータ規則に着地します。各プロパティには名前、値型、カテゴリ、説明が要ります。Factur-X 請求書が埋めるエントリは、拡張スキーマで fx プロパティを宣言するためのものです。リスティングは短い形式のアイテムを </rdf:Bag> の直前に差し込みます。ToXml はコンテナをその行に書くからです。アイテムは pdfaSchema と pdfaProperty を自分で宣言するので、どこに着地しても同じようにパースされます

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;

// スキーマエントリが Uri を記述しているとき True、綴りは問わない
function DescribesNamespace(const V: TPdfXmpValue; const Uri: string): Boolean;
var
  Q: Integer;
begin
  for Q := 0 to High(V.Qualifiers) do      // 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    // 要素
    (Pos('namespaceURI="' + Uri + '"', string(V.RawXml)) > 0);   // 属性
end;

// 新しいパケットを返す。解放は呼び出し側
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);                // 既に記述済み
  Xml := Packet.ToXml;
  P := Pos(ContainerEnd, Xml);
  if P > 0 then
    Insert(InvoiceSchemaItem, Xml, P)      // 既存の bag に参加
  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);         // 最初のリスティングから
  finally
    Written.Free;
  end;
end;

期待値: SaveAsPdfA が書いた PDF/A-1、-2、-3 のソースに対して、TagInvoice は適合行を印字し、4 つの拡張スキーマ値はどれも出しません。請求書エントリは短い形式で pdfaid エントリの隣に座ります。2 回目の実行は、既存エントリの綴りが何であれ bag に触れません。DescribesNamespace は RawXml を、空の rdf:li 上の属性については qualifiers を探すからです。別の接頭辞のコンテナは例外を上げます。新しいコンテナは veraPDF が拒む重複になるからです。ERP が支払期限を足したら、既存の pdfaSchema:property シーケンスを伸ばしましょう

PDF/A-4 はそもそも拡張スキーマを検査するのか

しません。ISO 19005-4 の §6.7.2.1 はパケットレベルの規則だけを残します。カタログの Metadata キー、非推奨の bytes と encoding ヘッダ属性、整形式 XML、UTF-8 です。記述のないプロパティも、nonpdfaSchema の下の記述も、pdfaSchema:schema を欠くものも、veraPDF の PDF/A-4 プロファイルの下ではファイルを適合のままにします。PDFium Component は 4 つの拡張スキーマ検査を、pdfaid:part が 1、2、3 のときにだけ走らせます。識別スキーマはどこでも自分の規則を保ちます。パート 4 の §6.7.3 の下でもその名前空間は pdfaid に束縛されねばならず、プロパティ集合はパートごとに育ちます。part、conformance、そして 2007 年の Amendment 1 以降はパート 1 に amd、ISO 19005-2 §6.6.4 からは corr、パート 4 では rev です。間違った接頭辞は pvaiXmpIdPrefixWrong と、余分な名前は pvaiXmpIdPropertyUnknown として、すべてのパートで報告されます

1 つの文書でパートを比較するには、パケットだけを変え、他は何も変えません。名前空間束縛を XMP の内側に挿入し、タグ間の空白のバイトを削れば、/Length、クロスリファレンスのオフセット、%PDF-2.0 ヘッダーは動きません。pypdf の書き換えは、%PDF-1.3 ヘッダー付きの PDF/A-4 ファイルを返してくることがあり、その失敗がメタデータの結果を埋めてしまいます。本番の出力では、PDF/A-4 のパケットにも記述を書き込みましょう。数百バイトのコストで、PDFium Component のバリデータはパート 4 の下でそれに触れず、パケットは後から PDF/A-3 の成果物へ無傷で移せます