スキーマによってXML文書を補う (PSVI)

(2018.8 新規作成, C#サンプル.)

@ ボヘミアン vs 貴族

DTD, W3C XML Schemaはスキーマにデフォルト値、固定値を含めることができます。一方、RELAX NGは含められません。

例えば、XML Schemaでは、次のように書いてデフォルト値を指定します。要素の内容のデフォルト値も指定できます。

HTML/XML
[RAW]
  1. <xsd:element name="comment" type="xsd:string" default="(comment space)" />
  2. <xsd:attribute name="quantity" type="xsd:integer" default="1" />

スキーマがデフォルト値などを持てるかどうかは、思想の問題です。スキーマの有無で, 処理すべきXML文書の値が変わることが, あっていいかどうか。

スキーマにより付加される情報があることを明確にするため、検証後のXML文書のことを PSVI -- Post-Schema-Validation Infoset -- と言うことがあります。

XML Schemaを推進する立場は、XML文書は「常に」スキーマとセットで処理されるべきであり、データ（XML要素の内容、属性値）は型を持つべき、というものです。突き詰めると、スキーマのないXML文書は無効、整形式のXML文書は廃止すべき、です。この立場は時に「貴族」と呼ばれます。

一方、RELAX NGを推進する立場は、XML文書はスキーマと組み合わせてもいいし、XML文書単独で使ってもよい、というもので、整形式のXML文書も排除しません。この立場は「ボヘミアン」と呼ばれます。

適用分野によっても違うのでしょうが、Web界隈だと、XML文書をXPathなどでつまみ食いしたりすることが多く、いちいちスキーマを要求されては実用になりません。

DTD

DTDのエンティティ宣言は, マクロです。単なるテキストだけでなく、タグなど構造すら生成できます。

次のXML文書を読み込んでみます。

HTML/XML
[RAW]
  1. <?xml version="1.0" encoding="UTF-16" ?>
  2. <?xml-stylesheet href="doc.xsl"
  3. type="text/xsl" ?>
  4. <!DOCTYPE foo [
  5. <!ENTITY x "foobar">
  6. <!ENTITY e "<p>text</p>">
  7. ]>
  8. <foo attr="&x;">
  9. &e;<![CDATA[<greeting>Hello, world!</greeting>]]>
  10. </foo>
  11. <!-- comment <head> <body> -->

C#で簡単に作ります. 構造を表示するため、ストリームパーサを使います。XmlNodeType.DocumentType では, DTD全体が得られます。

C++
[RAW]
  1. using System;
  2. using System.Collections.Generic;
  3. //using System.Linq;
  4. using System.Text;
  5. using System.Threading.Tasks;
  6. using System.Xml;
  9. namespace dtd_entity
  10. {
  12. class Program
  13. {
  14. // 2. ストリーム
  15. // 制限事項: unparsed entity-ref が致命的エラーになり、それ以上読めない.
  16. static void xml_stream_test(string doc_filename, XmlReaderSettings docSettings)
  17. {
  18. // fast, forward-only, non-cached access.
  19. XmlReader docReader;
  20. try {
  21. // XmlReader では, unparsed entity-ref が、どのようにしても、
  22. // 致命的エラー.
  23. docReader = XmlReader.Create(doc_filename, docSettings);
  25. // XmlTextReader class は非推奨.
  26. // unparsed entity-ref が許容できるように見えるが、やはり致命的エラー
  27. //docReader = new XmlTextReader(doc_filename);
  28. }
  29. catch (System.IO.FileNotFoundException ex) {
  30. Console.WriteLine(ex.Message);
  31. return;
  32. }
  34. while ( true ) { // Read() の戻り値は bool
  35. // XmlReader では, unparsed entity-ref は, ここで XmlException
  36. // が発生し, 以降 Read() が false を返すため, リカバリできない.
  37. bool cont = docReader.Read();
  38. if (!cont)
  39. break;
  41. // Attribute, Document, DocumentFragment は来ない.
  42. switch (docReader.NodeType)
  43. {
  44. // 宣言部
  45. case XmlNodeType.XmlDeclaration:
  46. Console.WriteLine("<?xml " + docReader.Value + ">");
  47. break;
  48. case XmlNodeType.DocumentType:
  49. Console.WriteLine("doctype: <!DOCTYPE {0} [{1}]>",
  50. docReader.Name, docReader.Value);
  51. break;
  52. case XmlNodeType.Whitespace:
  53. break;
  55. // document-type-end がないので、来ない.
  56. //case XmlNodeType.Entity:
  57. //case XmlNodeType.Notation:
  59. // 内容
  60. // [43] content ::= CharData? ((element | Reference | CDSect | PI | Comment) CharData?)*
  61. case XmlNodeType.Element: // 開始タグまたは空要素タグ
  62. Console.Write("stag: <{0}", docReader.Name);
  63. if (docReader.HasAttributes) {
  64. while (docReader.MoveToNextAttribute()) {
  65. Console.Write(" {0}=\"{1}\"",
  66. docReader.Name, docReader.Value);
  67. }
  68. // Move the reader back to the element node.
  69. docReader.MoveToElement();
  70. }
  71. if (docReader.IsEmptyElement )
  72. Console.WriteLine(" />");
  73. else
  74. Console.WriteLine(">");
  75. break;
  76. case XmlNodeType.Text:
  77. Console.WriteLine("text: " + docReader.Value);
  78. break;
  79. case XmlNodeType.CDATA:
  80. Console.WriteLine("cdata: <![CDATA[{0}]]>", docReader.Value);
  81. break;
  82. /* 展開されるので、来ない
  83. case XmlNodeType.EntityReference:
  84. // XmlTextReader なら, ここで catch できる.
  85. try {
  86. docReader.ResolveEntity();
  87. // 成功したときは, 次回の Read() で、展開した文字列を
  88. // 読み込む.
  89. }
  90. catch (XmlException ) {
  91. Console.Write("unparsed entity-ref: &" + docReader.Name + ";");
  92. }
  93. break;
  94. */
  95. case XmlNodeType.EndElement: // 終了タグ
  96. Console.WriteLine("etag: </{0}>", docReader.Name);
  97. break;
  98. /* 来ない
  99. case XmlNodeType.EndEntity:
  100. break; // 単に捨てる.
  101. */
  102. // 共通
  103. case XmlNodeType.ProcessingInstruction:
  104. Console.WriteLine("pi: <?{0} {1}?>", docReader.Name, docReader.Value);
  105. break;
  106. case XmlNodeType.Comment:
  107. Console.WriteLine("comment: <!--{0}-->", docReader.Value);
  108. break;
  109. default:
  110. Console.WriteLine("unexpected node!! " +
  111. docReader.NodeType.ToString());
  112. break;
  113. }
  114. } // end while
  116. docReader.Close();
  117. }
  120. static void Main(string[] args)
  121. {
  122. // 2. ストリーム
  123. XmlReaderSettings docSettings = new XmlReaderSettings();
  124. // ignore でも, "宣言されていないエンティティ 'x' への参照" エラーになる.
  125. docSettings.DtdProcessing = DtdProcessing.Parse;
  126. docSettings.IgnoreWhitespace = false;
  128. xml_stream_test("entity1.xml", docSettings);
  129. }
  130. }
  132. } // namespace dtd_entity

.NET の XmlReader は、非常に厳しい (厳密な) パーサです。

  • DTDを解釈し、エンティティ宣言を認識できる.
  • エンティティ参照をマクロとして展開できる.
  • 宣言されていないエンティティ参照は、致命的エラーになる。厳しすぎ。
  • ストリームパーサなのに, タグの対応のチェックも行われる。やはり致命的エラーになる。厳しすぎ.

XmlTextReaderクラスは非推奨です。エラーチェックが XmlReader より緩いのかと思って試してみましたが、一緒でした。ResolveEntity() で例外が発生した場合、次回以降の Read() が偽を返すため, 結局, エラーリカバリになりません。機能も微妙で, もはや選ぶ理由がありません。

XmlReader.Create() でインスタンス化するため, サブクラスを作って挙動を変えることもできません。どうしてこんなデザインにしたのか？

ともかく, 処理すると、次のようになります。エンティティ参照 &x; が展開された部分が、<p> 開始タグ、終了タグとして認識されています。 

<?xml version="1.0" encoding="UTF-16">
pi: <?xml-stylesheet href="doc.xsl"
                 type="text/xsl"   ?>
doctype: <!DOCTYPE foo [ 
<!ENTITY x "foobar"> 
<!ENTITY e "<p>text</p>">
]>
stag: <foo attr="foobar">
stag: <p>
text: text
etag: </p>
cdata: <![CDATA[<greeting>Hello, world!</greeting>]]>
etag: </foo>
comment: <!-- comment <head> <body> -->

W3C XML Schema

次のXML文書に対して,

HTML/XML
[RAW]
  1. <foo>
  2. <!-- 存在して、かつ空の場合だけ適用 -->
  3. <elm />
  4. <e2 />
  5. <comment />
  6. </foo>

次のスキーマで検証します。要素、属性の両方について、デフォルト値、固定値を設定してみます。

HTML/XML
[RAW]
  1. <?xml version="1.0" encoding="UTF-16" ?>
  2. <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  3. <xsd:element name="foo">
  4. <xsd:complexType>
  5. <xsd:sequence>
  6. <xsd:element name="elm" type="e1type" />
  7. <!-- default, fixed の内容は, テキストのみ. 複合型と両立しない. -->
  8. <xsd:element name="e2" type="xsd:string" default="hoge" />
  9. <xsd:element name="comment" type="xsd:string" fixed="here is comment" />
  10. </xsd:sequence>
  11. </xsd:complexType>
  12. </xsd:element>
  14. <xsd:complexType name="e1type">
  15. <xsd:attribute name="at1" type="xsd:integer" default="123" />
  16. <xsd:attribute name="at2" type="xsd:string" fixed="abc" />
  17. </xsd:complexType>
  18. </xsd:schema>

こちらも簡単に, C# で書きます。XmlReaderSettings インスタンスのSchemasプロパティに、スキーマ文書を足します。

C++
[RAW]
  1. using System;
  2. using System.Collections.Generic;
  3. //using System.Linq;
  4. using System.Text;
  5. using System.Threading.Tasks;
  6. using System.Xml;
  7. using System.Xml.Schema;
  9. namespace ConsoleApp1
  10. {
  12. class Program
  13. {
  14. static XmlReaderSettings validation_settings(string schema_filename)
  15. {
  16. // XML文書の読み込み設定
  17. XmlReaderSettings docSettings = new XmlReaderSettings();
  19. // XmlTextReader class は非推奨.
  20. XmlReader schemaReader = XmlReader.Create(schema_filename);
  22. // スキーマ文書自体の妥当性検証するとき.
  23. // System.IO.Stream, System.IO.TextReader, System.Xml.XmlReader
  24. XmlSchema myschema = XmlSchema.Read(schemaReader, ValidationCallback);
  26. // スキーマ文書の妥当性検証をしないときは, XmlReader インスタンスを
  27. // 渡せばよい.
  28. //docSettings.Schemas.Add(null, schemaReader);
  29. docSettings.Schemas.Add(myschema);
  31. // XML文書の妥当性検証するように設定
  32. // The default is no data validation.
  33. docSettings.ValidationType = ValidationType.Schema;
  34. docSettings.ValidationEventHandler += ValidationCallback;
  36. // The default is Prohibit: XmlException を投げる.
  37. //docSettings.DtdProcessing = DtdProcessing.Parse;
  39. // By default, ProcessIdentityConstraints and AllowXmlAttributes.
  40. docSettings.ValidationFlags |=
  41. XmlSchemaValidationFlags.ReportValidationWarnings;
  43. foreach (XmlSchema schema in docSettings.Schemas.Schemas()) {
  44. schema.Write(Console.Out); // DEBUG
  45. }
  46. Console.WriteLine("");
  48. return docSettings;
  49. }
  52. static void Main(string[] args)
  53. {
  54. // 1. DOM読み込み時に妥当性検証する
  55. string schema_filename = @"schema1.xsd";
  57. XmlReaderSettings docSettings = validation_settings(schema_filename);
  58. XmlReader docReader = XmlReader.Create(@"doc1.xml", docSettings);
  60. XmlDocument doc = new XmlDocument();
  61. doc.Load(docReader);
  62. docReader.Close();
  64. Console.WriteLine(doc.OuterXml); // DEBUG
  65. foreach (XmlAttribute a in doc.ChildNodes[0].ChildNodes[1].Attributes) {
  66. Console.WriteLine("{0}={1}", a.Name, a.Value);
  67. }
  68. }
  71. // for ValidationEventHandler
  72. static void ValidationCallback(object sender, ValidationEventArgs args)
  73. {
  74. if (args.Severity == XmlSeverityType.Warning) {
  75. Console.Write("WARNING: ");
  76. Console.WriteLine(args.Message);
  77. }
  78. else if (args.Severity == XmlSeverityType.Error) {
  79. Console.Write("ERROR: ");
  80. Console.WriteLine(args.Message);
  81. }
  82. }
  83. }
  84. } // namespace ConsoleApp1

処理すると, 次のようになります。e2 要素と comment 要素の内容が補われていることに注目。

属性のほうは、OuterXml では表示されないですが、Attributes 経由で見ると、補われていることが分かります。 

<?xml version="1.0" encoding="shift_jis"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="foo">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="elm" type="e1type" />
        <xsd:element default="hoge" name="e2" type="xsd:string" />
        <xsd:element fixed="here is comment" name="comment" type="xsd:string" />
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>
  <xsd:complexType name="e1type">
    <xsd:attribute default="123" name="at1" type="xsd:integer" />
    <xsd:attribute fixed="abc" name="at2" type="xsd:string" />
  </xsd:complexType>
</xsd:schema>
<foo><!-- 存在して、かつ空の場合だけ適用 --><elm /><e2>hoge</e2><comment>here is comment</comment></foo>
at1=123
at2=abc