2 // System.Xml.XmlValidatingReader.cs
5 // Tim Coleman (tim@timcoleman.com)
6 // Atsushi Enomoto (ginga@kit.hi-ho.ne.jp)
8 // Copyright (C) Tim Coleman, 2002
9 // (C)2003 Atsushi Enomoto
10 // Copyright (C) 2005 Novell, Inc (http://www.novell.com)
12 // Permission is hereby granted, free of charge, to any person obtaining
13 // a copy of this software and associated documentation files (the
14 // "Software"), to deal in the Software without restriction, including
15 // without limitation the rights to use, copy, modify, merge, publish,
16 // distribute, sublicense, and/or sell copies of the Software, and to
17 // permit persons to whom the Software is furnished to do so, subject to
18 // the following conditions:
20 // The above copyright notice and this permission notice shall be
21 // included in all copies or substantial portions of the Software.
23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
27 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
28 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
29 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33 using System.Collections.Generic;
36 using System.Security.Permissions;
38 using System.Xml.Schema;
40 using Mono.Xml.Schema;
44 [PermissionSet (SecurityAction.InheritanceDemand, Unrestricted = true)]
46 [Obsolete("Use XmlReader created by XmlReader.Create() method using"
47 + " appropriate XmlReaderSettings instead.")]
48 public class XmlValidatingReader : XmlReader, IXmlLineInfo, IXmlNamespaceResolver, IHasXmlParserContext
50 public class XmlValidatingReader : XmlReader, IXmlLineInfo, IHasXmlParserContext
56 EntityHandling entityHandling;
57 XmlReader sourceReader;
58 XmlTextReader xmlTextReader;
59 XmlReader validatingReader;
60 XmlResolver resolver; // Only used to non-XmlTextReader XmlReader
61 bool resolverSpecified;
62 ValidationType validationType;
63 // for 2.0: Now it is obsolete. It is allocated only when it is required
65 DTDValidatingReader dtdReader;
66 IHasXmlSchemaInfo schemaInfo;
67 StringBuilder storedCharacters;
73 public XmlValidatingReader (XmlReader reader)
75 sourceReader = reader;
76 xmlTextReader = reader as XmlTextReader;
77 if (xmlTextReader == null)
78 resolver = new XmlUrlResolver ();
79 entityHandling = EntityHandling.ExpandEntities;
80 validationType = ValidationType.Auto;
81 storedCharacters = new StringBuilder ();
84 public XmlValidatingReader (Stream xmlFragment, XmlNodeType fragType, XmlParserContext context)
85 : this (new XmlTextReader (xmlFragment, fragType, context))
89 public XmlValidatingReader (string xmlFragment, XmlNodeType fragType, XmlParserContext context)
90 : this (new XmlTextReader (xmlFragment, fragType, context))
94 #endregion // Constructors
98 public override int AttributeCount {
99 get { return validatingReader == null ? 0 : validatingReader.AttributeCount; }
102 public override string BaseURI {
103 get { return validatingReader == null ? sourceReader.BaseURI : validatingReader.BaseURI; }
106 // This property for this class always return true.
107 public override bool CanResolveEntity {
111 public override int Depth {
112 get { return validatingReader == null ? 0 : validatingReader.Depth; }
115 public Encoding Encoding {
117 if (xmlTextReader != null)
118 return xmlTextReader.Encoding;
120 throw new NotSupportedException ("Encoding is supported only for XmlTextReader.");
124 public EntityHandling EntityHandling {
125 get { return entityHandling; }
127 entityHandling = value;
128 if (dtdReader != null)
129 dtdReader.EntityHandling = value;
133 public override bool EOF {
134 get { return validatingReader == null ? false : validatingReader.EOF; }
137 #if DTD_HANDLE_EVENTS
138 internal bool HasValidationEvent {
139 get { return ValidationEventHandler != null; }
143 public override bool HasValue {
144 get { return validatingReader == null ? false : validatingReader.HasValue; }
147 public override bool IsDefault {
148 get { return validatingReader == null ? false : validatingReader.IsDefault; }
151 public override bool IsEmptyElement {
152 get { return validatingReader == null ? false : validatingReader.IsEmptyElement; }
157 public override string this [int i] {
158 get { return GetAttribute (i); }
161 public override string this [string name] {
162 get { return GetAttribute (name); }
165 public override string this [string localName, string namespaceName] {
166 get { return GetAttribute (localName, namespaceName); }
171 public int LineNumber {
173 int IXmlLineInfo.LineNumber {
178 IXmlLineInfo info = validatingReader as IXmlLineInfo;
179 return info != null ? info.LineNumber : 0;
184 public int LinePosition {
186 int IXmlLineInfo.LinePosition {
191 IXmlLineInfo info = validatingReader as IXmlLineInfo;
192 return info != null ? info.LinePosition : 0;
196 public override string LocalName {
198 if (validatingReader == null)
201 return validatingReader.LocalName;
203 return validatingReader.Name;
207 public override string Name {
208 get { return validatingReader == null ? String.Empty : validatingReader.Name; }
211 public bool Namespaces {
213 if (xmlTextReader != null)
214 return xmlTextReader.Namespaces;
219 if (ReadState != ReadState.Initial)
220 throw new InvalidOperationException ("Namespaces have to be set before reading.");
222 if (xmlTextReader != null)
223 xmlTextReader.Namespaces = value;
225 throw new NotSupportedException ("Property 'Namespaces' is supported only for XmlTextReader.");
229 public override string NamespaceURI {
231 if (validatingReader == null)
234 return validatingReader.NamespaceURI;
240 public override XmlNameTable NameTable {
241 get { return validatingReader == null ? sourceReader.NameTable : validatingReader.NameTable; }
244 public override XmlNodeType NodeType {
245 get { return validatingReader == null ? XmlNodeType.None : validatingReader.NodeType; }
248 public override string Prefix {
249 get { return validatingReader == null ? String.Empty : validatingReader.Prefix; }
252 public override char QuoteChar {
253 get { return validatingReader == null ? sourceReader.QuoteChar : validatingReader.QuoteChar; }
256 public XmlReader Reader {
257 get { return sourceReader; }
260 public override ReadState ReadState {
262 if (validatingReader == null)
263 return ReadState.Initial;
264 return validatingReader.ReadState;
268 internal XmlResolver Resolver {
270 // This is special rule... MS.NET shares the
271 // XmlResolver between XmlTextReader and
272 // XmlValidatingReader, so we mimick that
273 // silly behavior here.
274 if (this.xmlTextReader != null)
275 return this.xmlTextReader.Resolver;
276 else if (resolverSpecified)
283 public XmlSchemaCollection Schemas {
286 schemas = new XmlSchemaSet ();
287 return schemas.SchemaCollection;
291 internal void SetSchemas (XmlSchemaSet schemas)
293 this.schemas = schemas;
296 public object SchemaType {
297 get { return schemaInfo.SchemaType; }
302 public override XmlReaderSettings Settings {
303 get { return validatingReader == null ? sourceReader.Settings : validatingReader.Settings; }
307 [MonoTODO ("We decided not to support XDR schema that spec is obsolete.")]
308 public ValidationType ValidationType {
309 get { return validationType; }
311 if (ReadState != ReadState.Initial)
312 throw new InvalidOperationException ("ValidationType cannot be set after the first call to Read method.");
313 switch (validationType) {
314 case ValidationType.Auto:
315 case ValidationType.DTD:
316 case ValidationType.None:
317 case ValidationType.Schema:
318 validationType = value;
320 case ValidationType.XDR:
321 throw new NotSupportedException ();
326 public override string Value {
327 get { return validatingReader == null ? String.Empty : validatingReader.Value; }
330 public override string XmlLang {
331 get { return validatingReader == null ? String.Empty : validatingReader.XmlLang; }
334 public XmlResolver XmlResolver {
336 resolverSpecified = true;
338 if (xmlTextReader != null)
339 xmlTextReader.XmlResolver = value;
341 XsdValidatingReader xsvr = validatingReader as XsdValidatingReader;
343 xsvr.XmlResolver = value;
344 DTDValidatingReader dvr = validatingReader as DTDValidatingReader;
346 dvr.XmlResolver = value;
350 public override XmlSpace XmlSpace {
351 get { return validatingReader == null ? XmlSpace.None : validatingReader.XmlSpace; }
354 #endregion // Properties
358 public override void Close ()
360 if (validatingReader == null)
361 sourceReader.Close ();
363 validatingReader.Close ();
366 public override string GetAttribute (int i)
368 if (validatingReader == null)
369 throw new IndexOutOfRangeException ("Reader is not started.");
370 return validatingReader [i];
373 public override string GetAttribute (string name)
375 return validatingReader == null ? null : validatingReader [name];
378 public override string GetAttribute (string localName, string namespaceName)
380 return validatingReader == null ? null : validatingReader [localName, namespaceName];
383 XmlParserContext IHasXmlParserContext.ParserContext {
384 get { return dtdReader != null ? dtdReader.ParserContext : null; }
388 IDictionary<string, string> IXmlNamespaceResolver.GetNamespacesInScope (XmlNamespaceScope scope)
390 return ((IHasXmlParserContext) this).ParserContext.NamespaceManager.GetNamespacesInScope (scope);
395 public bool HasLineInfo ()
397 bool IXmlLineInfo.HasLineInfo ()
400 IXmlLineInfo info = validatingReader as IXmlLineInfo;
401 return info != null ? info.HasLineInfo () : false;
404 public override string LookupNamespace (string prefix)
406 if (validatingReader != null)
407 return validatingReader.LookupNamespace (prefix);
409 return sourceReader.LookupNamespace (prefix);
413 string IXmlNamespaceResolver.LookupPrefix (string ns)
415 IXmlNamespaceResolver res = null;
416 if (validatingReader != null)
417 res = sourceReader as IXmlNamespaceResolver;
419 res = validatingReader as IXmlNamespaceResolver;
421 res.LookupNamespace (ns) :
427 public override void MoveToAttribute (int i)
429 if (validatingReader == null)
430 throw new IndexOutOfRangeException ("Reader is not started.");
432 validatingReader.MoveToAttribute (i);
435 public override bool MoveToAttribute (string name)
437 if (validatingReader == null)
439 return validatingReader.MoveToAttribute (name);
442 public override bool MoveToAttribute (string localName, string namespaceName)
444 if (validatingReader == null)
446 return validatingReader.MoveToAttribute (localName, namespaceName);
449 public override bool MoveToElement ()
451 if (validatingReader == null)
453 return validatingReader.MoveToElement ();
456 public override bool MoveToFirstAttribute ()
458 if (validatingReader == null)
460 return validatingReader.MoveToFirstAttribute ();
463 public override bool MoveToNextAttribute ()
465 if (validatingReader == null)
467 return validatingReader.MoveToNextAttribute ();
470 [MonoTODO ("We decided not to support XDR schema that spec is obsolete.")]
471 public override bool Read ()
473 if (ReadState == ReadState.Initial) {
474 switch (ValidationType) {
475 case ValidationType.Auto:
476 case ValidationType.None:
477 goto case ValidationType.Schema; // might be specified by xsi:schemaLocation.
478 case ValidationType.DTD:
479 validatingReader = dtdReader = new DTDValidatingReader (sourceReader, this);
480 dtdReader.XmlResolver = Resolver;
482 case ValidationType.Schema:
483 dtdReader = new DTDValidatingReader (sourceReader, this);
484 XsdValidatingReader xsvr = new XsdValidatingReader (dtdReader);
485 xsvr.ValidationEventHandler +=
486 new ValidationEventHandler (
488 xsvr.ValidationType = ValidationType;
489 xsvr.Schemas = Schemas.SchemaSet;
490 xsvr.XmlResolver = Resolver;
491 validatingReader = xsvr;
492 dtdReader.XmlResolver = Resolver;
494 case ValidationType.XDR:
495 throw new NotSupportedException ();
497 schemaInfo = validatingReader as IHasXmlSchemaInfo;
499 return validatingReader.Read ();
502 public override bool ReadAttributeValue ()
504 if (validatingReader == null)
506 return validatingReader.ReadAttributeValue ();
510 // LAMESPEC: MS.NET 1.0 has critical bug here.
511 // After calling these methods, validation does not work anymore!
512 public override string ReadInnerXml ()
514 if (validatingReader == null)
516 return validatingReader.ReadInnerXml ();
519 public override string ReadOuterXml ()
521 if (validatingReader == null)
523 return validatingReader.ReadOuterXml ();
528 public override string ReadString ()
530 return base.ReadStringInternal ();
533 public override string ReadString ()
535 return base.ReadString ();
541 public override object ReadTypedValue ()
543 public object ReadTypedValue ()
546 if (dtdReader == null)
548 XmlSchemaDatatype dt = schemaInfo.SchemaType as XmlSchemaDatatype;
552 case XmlNodeType.Element:
556 storedCharacters.Length = 0;
561 case XmlNodeType.SignificantWhitespace:
562 case XmlNodeType.Text:
563 case XmlNodeType.CDATA:
564 storedCharacters.Append (Value);
566 case XmlNodeType.Comment:
572 } while (loop && !EOF);
573 return dt.ParseValue (storedCharacters.ToString (), NameTable, dtdReader.ParserContext.NamespaceManager);
574 case XmlNodeType.Attribute:
575 return dt.ParseValue (Value, NameTable, dtdReader.ParserContext.NamespaceManager);
580 public override void ResolveEntity ()
582 validatingReader.ResolveEntity ();
585 // It should be "protected" as usual "event model"
586 // methods are, but validation event is not exposed,
587 // so it is no other way to make it "internal".
588 internal void OnValidationEvent (object o, ValidationEventArgs e)
590 if (ValidationEventHandler != null)
591 ValidationEventHandler (o, e);
592 else if (ValidationType != ValidationType.None && e.Severity == XmlSeverityType.Error)
597 [MonoTODO ("Check how expanded entity is handled here.")]
598 public override int ReadContentAsBase64 (byte [] buffer, int offset, int length)
600 if (validatingReader != null)
601 return validatingReader.ReadContentAsBase64 (buffer, offset, length);
603 return sourceReader.ReadContentAsBase64 (buffer, offset, length);
606 [MonoTODO ("Check how expanded entity is handled here.")]
607 public override int ReadContentAsBinHex (byte [] buffer, int offset, int length)
609 if (validatingReader != null)
610 return validatingReader.ReadContentAsBinHex (buffer, offset, length);
612 return sourceReader.ReadContentAsBinHex (buffer, offset, length);
615 [MonoTODO ("Check how expanded entity is handled here.")]
616 public override int ReadElementContentAsBase64 (byte [] buffer, int offset, int length)
618 if (validatingReader != null)
619 return validatingReader.ReadElementContentAsBase64 (buffer, offset, length);
621 return sourceReader.ReadElementContentAsBase64 (buffer, offset, length);
624 [MonoTODO ("Check how expanded entity is handled here.")]
625 public override int ReadElementContentAsBinHex (byte [] buffer, int offset, int length)
627 if (validatingReader != null)
628 return validatingReader.ReadElementContentAsBinHex (buffer, offset, length);
630 return sourceReader.ReadElementContentAsBinHex (buffer, offset, length);
633 #endregion // Methods
635 #region Events and Delegates
637 public event ValidationEventHandler ValidationEventHandler;
639 #endregion // Events and Delegates