mcs/class/System.XML/System.Xml/XmlValidatingReader.cs

   1 //
   2 // System.Xml.XmlValidatingReader.cs
   3 //
   4 // Author:
   5 //   Tim Coleman (tim@timcoleman.com)
   6 //   Atsushi Enomoto (ginga@kit.hi-ho.ne.jp)
   7 //
   8 // Copyright (C) Tim Coleman, 2002
   9 // (C)2003 Atsushi Enomoto
  10 //
  11
  12 //
  13 // Permission is hereby granted, free of charge, to any person obtaining
  14 // a copy of this software and associated documentation files (the
  15 // "Software"), to deal in the Software without restriction, including
  16 // without limitation the rights to use, copy, modify, merge, publish,
  17 // distribute, sublicense, and/or sell copies of the Software, and to
  18 // permit persons to whom the Software is furnished to do so, subject to
  19 // the following conditions:
  20 //
  21 // The above copyright notice and this permission notice shall be
  22 // included in all copies or substantial portions of the Software.
  23 //
  24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  28 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  29 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  30 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  31 //
  32
  33 using System.Collections;
  34 using System.IO;
  35 using System.Text;
  36 using System.Xml.Schema;
  37 using Mono.Xml;
  38 using Mono.Xml.Schema;
  39
  40 namespace System.Xml
  41 {
  42 #if NET_2_0
  43         [Obsolete("Use XmlReader created by XmlReader.Create() method using"
  44                 + " appropriate XmlReaderSettings instead.")]
  45         public class XmlValidatingReader : XmlReader, IXmlLineInfo, IXmlNamespaceResolver, IHasXmlParserContext
  46 #else
  47         public class XmlValidatingReader : XmlReader, IXmlLineInfo, IHasXmlParserContext
  48 #endif
  49         {
  50
  51                 #region Fields
  52
  53                 EntityHandling entityHandling;
  54                 XmlReader sourceReader;
  55                 XmlTextReader xmlTextReader;
  56                 XmlReader validatingReader;
  57                 XmlResolver resolver; // Only used to non-XmlTextReader XmlReader
  58                 bool specifiedResolver;
  59                 ValidationType validationType;
  60                 // for 2.0: Now it is obsolete. It is allocated only when it is required
  61                 XmlSchemaSet schemas;
  62                 DTDValidatingReader dtdReader;
  63                 IHasXmlSchemaInfo schemaInfo;
  64                 StringBuilder storedCharacters;
  65
  66                 #endregion // Fields
  67
  68                 #region Constructors
  69
  70                 public XmlValidatingReader (XmlReader reader)
  71                 {
  72                         sourceReader = reader;
  73                         xmlTextReader = reader as XmlTextReader;
  74                         if (xmlTextReader == null)
  75                                 resolver = new XmlUrlResolver ();
  76                         entityHandling = EntityHandling.ExpandEntities;
  77                         validationType = ValidationType.Auto;
  78                         schemas = new XmlSchemaSet ();
  79                         storedCharacters = new StringBuilder ();
  80                 }
  81
  82                 public XmlValidatingReader (Stream xmlFragment, XmlNodeType fragType, XmlParserContext context)
  83                         : this (new XmlTextReader (xmlFragment, fragType, context))
  84                 {
  85                 }
  86
  87                 public XmlValidatingReader (string xmlFragment, XmlNodeType fragType, XmlParserContext context)
  88                         : this (new XmlTextReader (xmlFragment, fragType, context))
  89                 {
  90                 }
  91
  92                 #endregion // Constructors
  93
  94                 #region Properties
  95
  96                 public override int AttributeCount {
  97                         get { return validatingReader == null ? 0 : validatingReader.AttributeCount; }
  98                 }
  99
 100                 public override string BaseURI {
 101                         get { return validatingReader == null ? sourceReader.BaseURI : validatingReader.BaseURI; }
 102                 }
 103
 104                 // This property for this class always return true.
 105                 public override bool CanResolveEntity {
 106                         get { return true; }
 107                 }
 108
 109                 public override int Depth {
 110                         get { return validatingReader == null ? 0 : validatingReader.Depth; }
 111                 }
 112
 113                 public Encoding Encoding {
 114                         get {
 115                                 if (xmlTextReader != null)
 116                                         return xmlTextReader.Encoding;
 117                                 else
 118                                         throw new NotSupportedException ("Encoding is supported only for XmlTextReader.");
 119                         }
 120                 }
 121
 122                 public EntityHandling EntityHandling {
 123                         get { return entityHandling; }
 124                         set { entityHandling = value; }
 125                 }
 126
 127                 public override bool EOF {
 128                         get { return validatingReader == null ? false : validatingReader.EOF; }
 129                 }
 130
 131 #if DTD_HANDLE_EVENTS
 132                 internal bool HasValidationEvent {
 133                         get { return ValidationEventHandler != null; }
 134                 }
 135 #endif
 136
 137                 public override bool HasValue {
 138                         get { return validatingReader == null ? false : validatingReader.HasValue; }
 139                 }
 140
 141                 public override bool IsDefault {
 142                         get { return validatingReader == null ? false : validatingReader.IsDefault; }
 143                 }
 144
 145                 public override bool IsEmptyElement {
 146                         get { return validatingReader == null ? false : validatingReader.IsEmptyElement; }
 147                 }
 148
 149 #if NET_2_0
 150 #else
 151                 public override string this [int i] {
 152                         get { return GetAttribute (i); }
 153                 }
 154
 155                 public override string this [string name] {
 156                         get { return GetAttribute (name); }
 157                 }
 158
 159                 public override string this [string localName, string namespaceName] {
 160                         get { return GetAttribute (localName, namespaceName); }
 161                 }
 162 #endif
 163
 164 #if NET_2_0
 165                 public int LineNumber {
 166 #else
 167                 int IXmlLineInfo.LineNumber {
 168 #endif
 169                         get {
 170                                 if (IsDefault)
 171                                         return 0;
 172                                 IXmlLineInfo info = validatingReader as IXmlLineInfo;
 173                                 return info != null ? info.LineNumber : 0;
 174                         }
 175                 }
 176
 177 #if NET_2_0
 178                 public int LinePosition {
 179 #else
 180                 int IXmlLineInfo.LinePosition {
 181 #endif
 182                         get {
 183                                 if (IsDefault)
 184                                         return 0;
 185                                 IXmlLineInfo info = validatingReader as IXmlLineInfo;
 186                                 return info != null ? info.LinePosition : 0;
 187                         }
 188                 }
 189
 190                 public override string LocalName {
 191                         get {
 192                                 if (validatingReader == null)
 193                                         return String.Empty;
 194                                 else if (Namespaces)
 195                                         return validatingReader.LocalName;
 196                                 else
 197                                         return validatingReader.Name;
 198                         }
 199                 }
 200
 201                 public override string Name {
 202                         get { return validatingReader == null ? String.Empty : validatingReader.Name; }
 203                 }
 204
 205                 public bool Namespaces {
 206                         get {
 207                                 if (xmlTextReader != null)
 208                                         return xmlTextReader.Namespaces;
 209                                 else
 210                                         return true;
 211                         }
 212                         set {
 213                                 if (ReadState != ReadState.Initial)
 214                                         throw new InvalidOperationException ("Namespaces have to be set before reading.");
 215
 216                                 if (xmlTextReader != null)
 217                                         xmlTextReader.Namespaces = value;
 218                                 else
 219                                         throw new NotSupportedException ("Property 'Namespaces' is supported only for XmlTextReader.");
 220                         }
 221                 }
 222
 223                 public override string NamespaceURI {
 224                         get {
 225                                 if (validatingReader == null)
 226                                         return String.Empty;
 227                                 else if (Namespaces)
 228                                         return validatingReader.NamespaceURI;
 229                                 else
 230                                         return String.Empty;
 231                         }
 232                 }
 233
 234                 public override XmlNameTable NameTable {
 235                         get { return validatingReader == null ? sourceReader.NameTable : validatingReader.NameTable; }
 236                 }
 237
 238                 public override XmlNodeType NodeType {
 239                         get { return validatingReader == null ? XmlNodeType.None : validatingReader.NodeType; }
 240                 }
 241
 242                 public override string Prefix {
 243                         get { return validatingReader == null ? String.Empty : validatingReader.Prefix; }
 244                 }
 245
 246                 public override char QuoteChar {
 247                         get { return validatingReader == null ? sourceReader.QuoteChar : validatingReader.QuoteChar; }
 248                 }
 249
 250                 public XmlReader Reader {
 251                         get { return sourceReader; }
 252                 }
 253
 254                 public override ReadState ReadState {
 255                         get {
 256                                 if (validatingReader == null)
 257                                         return ReadState.Initial;
 258                                 return validatingReader.ReadState;
 259                         }
 260                 }
 261
 262                 internal XmlResolver Resolver {
 263                         get {
 264                                 // This is special rule... MS.NET shares the
 265                                 // XmlResolver between XmlTextReader and
 266                                 // XmlValidatingReader, so we mimick that
 267                                 // silly behavior here.
 268                                 if (this.xmlTextReader != null)
 269                                         return this.xmlTextReader.Resolver;
 270                                 else
 271                                         return resolver;
 272                         }
 273                 }
 274
 275                 public XmlSchemaCollection Schemas {
 276                         get {
 277                                 return schemas.SchemaCollection;
 278                         }
 279                 }
 280
 281                 internal void SetSchemas (XmlSchemaSet schemas)
 282                 {
 283                         this.schemas = schemas;
 284                 }
 285
 286                 public object SchemaType {
 287                         get { return schemaInfo.SchemaType; }
 288                 }
 289
 290 #if NET_2_0
 291                 [MonoTODO]
 292                 public override XmlReaderSettings Settings {
 293                         get { return validatingReader == null ? sourceReader.Settings : validatingReader.Settings; }
 294                 }
 295 #endif
 296
 297                 [MonoTODO ("We decided not to support XDR schema that spec is obsolete.")]
 298                 public ValidationType ValidationType {
 299                         get { return validationType; }
 300                         set {
 301                                 if (ReadState != ReadState.Initial)
 302                                         throw new InvalidOperationException ("ValidationType cannot be set after the first call to Read method.");
 303                                 switch (validationType) {
 304                                 case ValidationType.Auto:
 305                                 case ValidationType.DTD:
 306                                 case ValidationType.None:
 307                                 case ValidationType.Schema:
 308                                         validationType = value;
 309                                         break;
 310                                 case ValidationType.XDR:
 311                                         throw new NotSupportedException ();
 312                                 }
 313                         }
 314                 }
 315
 316                 public override string Value {
 317                         get { return validatingReader == null ? String.Empty : validatingReader.Value; }
 318                 }
 319
 320                 public override string XmlLang {
 321                         get { return validatingReader == null ? String.Empty : validatingReader.XmlLang; }
 322                 }
 323
 324                 public XmlResolver XmlResolver {
 325                         set {
 326                                 specifiedResolver = true;
 327                                 if (xmlTextReader != null)
 328                                         xmlTextReader.XmlResolver = value;
 329                                 else
 330                                         resolver = value;
 331
 332                                 XsdValidatingReader xsvr = validatingReader as XsdValidatingReader;
 333                                 if (xsvr != null)
 334                                         xsvr.XmlResolver = value;
 335                                 DTDValidatingReader dvr = validatingReader as DTDValidatingReader;
 336                                 if (dvr != null)
 337                                         dvr.XmlResolver = value;
 338                         }
 339                 }
 340
 341                 public override XmlSpace XmlSpace {
 342                         get { return validatingReader == null ? XmlSpace.None : validatingReader.XmlSpace; }
 343                 }
 344
 345                 #endregion // Properties
 346
 347                 #region Methods
 348
 349                 public override void Close ()
 350                 {
 351                         if (validatingReader == null)
 352                                 sourceReader.Close ();
 353                         else
 354                                 validatingReader.Close ();
 355                 }
 356
 357                 public override string GetAttribute (int i)
 358                 {
 359                         if (validatingReader == null)
 360                                 throw new IndexOutOfRangeException ("Reader is not started.");
 361                         return validatingReader [i];
 362                 }
 363
 364                 public override string GetAttribute (string name)
 365                 {
 366                         return validatingReader == null ? null : validatingReader [name];
 367                 }
 368
 369                 public override string GetAttribute (string localName, string namespaceName)
 370                 {
 371                         return validatingReader == null ? null : validatingReader [localName, namespaceName];
 372                 }
 373
 374                 XmlParserContext IHasXmlParserContext.ParserContext {
 375                         get { return dtdReader != null ? dtdReader.ParserContext : null; }
 376                 }
 377
 378 #if NET_2_0
 379                 IDictionary IXmlNamespaceResolver.GetNamespacesInScope (XmlNamespaceScope scope)
 380                 {
 381                         return ((IHasXmlParserContext) this).ParserContext.NamespaceManager.GetNamespacesInScope (scope);
 382                 }
 383 #endif
 384
 385 #if NET_2_0
 386                 public bool HasLineInfo ()
 387 #else
 388                 bool IXmlLineInfo.HasLineInfo ()
 389 #endif
 390                 {
 391                         IXmlLineInfo info = validatingReader as IXmlLineInfo;
 392                         return info != null ? info.HasLineInfo () : false;
 393                 }
 394
 395                 public override string LookupNamespace (string prefix)
 396                 {
 397                         if (validatingReader != null)
 398                                 return sourceReader.LookupNamespace (prefix);
 399                         else
 400                                 return validatingReader.LookupNamespace (prefix);
 401                 }
 402
 403 #if NET_2_0
 404                 string IXmlNamespaceResolver.LookupPrefix (string ns)
 405                 {
 406                         IXmlNamespaceResolver res = null;
 407                         if (validatingReader != null)
 408                                 res = sourceReader as IXmlNamespaceResolver;
 409                         else
 410                                 res = validatingReader as IXmlNamespaceResolver;
 411                         return res != null ?
 412                                 res.LookupNamespace (ns) :
 413                                 null;
 414                 }
 415
 416                 string IXmlNamespaceResolver.LookupPrefix (string ns, bool atomizedNames)
 417                 {
 418                         IXmlNamespaceResolver res = null;
 419                         if (validatingReader != null)
 420                                 res = sourceReader as IXmlNamespaceResolver;
 421                         else
 422                                 res = validatingReader as IXmlNamespaceResolver;
 423                         return res != null ?
 424                                 res.LookupNamespace (ns, atomizedNames) :
 425                                 null;
 426                 }
 427 #endif
 428
 429
 430                 public override void MoveToAttribute (int i)
 431                 {
 432                         if (validatingReader == null)
 433                                 throw new IndexOutOfRangeException ("Reader is not started.");
 434                         else
 435                                 validatingReader.MoveToAttribute (i);
 436                 }
 437
 438                 public override bool MoveToAttribute (string name)
 439                 {
 440                         if (validatingReader == null)
 441                                 return false;
 442                         return validatingReader.MoveToAttribute (name);
 443                 }
 444
 445                 public override bool MoveToAttribute (string localName, string namespaceName)
 446                 {
 447                         if (validatingReader == null)
 448                                 return false;
 449                         return validatingReader.MoveToAttribute (localName, namespaceName);
 450                 }
 451
 452                 public override bool MoveToElement ()
 453                 {
 454                         if (validatingReader == null)
 455                                 return false;
 456                         return validatingReader.MoveToElement ();
 457                 }
 458
 459                 public override bool MoveToFirstAttribute ()
 460                 {
 461                         if (validatingReader == null)
 462                                 return false;
 463                         return validatingReader.MoveToFirstAttribute ();
 464                 }
 465
 466                 public override bool MoveToNextAttribute ()
 467                 {
 468                         if (validatingReader == null)
 469                                 return false;
 470                         return validatingReader.MoveToNextAttribute ();
 471                 }
 472
 473                 [MonoTODO ("We decided not to support XDR schema that spec is obsolete.")]
 474                 public override bool Read ()
 475                 {
 476                         if (ReadState == ReadState.Initial) {
 477                                 switch (ValidationType) {
 478                                 case ValidationType.Auto:
 479                                 case ValidationType.None:
 480                                         goto case ValidationType.Schema; // might be specified by xsi:schemaLocation.
 481                                 case ValidationType.DTD:
 482                                         validatingReader = dtdReader = new DTDValidatingReader (sourceReader, this);
 483                                         dtdReader.XmlResolver = Resolver;
 484                                         break;
 485                                 case ValidationType.Schema:
 486                                         dtdReader = new DTDValidatingReader (sourceReader, this);
 487                                         XsdValidatingReader xsvr = new XsdValidatingReader (dtdReader, this);
 488                                         xsvr.Schemas = Schemas.SchemaSet;
 489                                         validatingReader = xsvr;
 490                                         xsvr.XmlResolver = Resolver;
 491                                         dtdReader.XmlResolver = Resolver;
 492                                         break;
 493                                 case ValidationType.XDR:
 494                                         throw new NotSupportedException ();
 495                                 }
 496                                 schemaInfo = validatingReader as IHasXmlSchemaInfo;
 497                         }
 498                         return validatingReader.Read ();
 499                 }
 500
 501                 public override bool ReadAttributeValue ()
 502                 {
 503                         if (validatingReader == null)
 504                                 return false;
 505                         return validatingReader.ReadAttributeValue ();
 506                 }
 507
 508 #if NET_1_0
 509                 // LAMESPEC: MS.NET 1.0 has critical bug here.
 510                 // After calling these methods, validation does not work anymore!
 511                 public override string ReadInnerXml ()
 512                 {
 513                         if (validatingReader == null)
 514                                 return "";
 515                         return validatingReader.ReadInnerXml ();
 516                 }
 517
 518                 public override string ReadOuterXml ()
 519                 {
 520                         if (validatingReader == null)
 521                                 return "";
 522                         return validatingReader.ReadOuterXml ();
 523                 }
 524 #endif
 525
 526 #if NET_1_0
 527                 public override string ReadString ()
 528                 {
 529                         return base.ReadStringInternal ();
 530                 }
 531 #else
 532                 public override string ReadString ()
 533                 {
 534                         return base.ReadString ();
 535                 }
 536 #endif
 537
 538 #if NET_2_0
 539                 public override object ReadTypedValue ()
 540 #else
 541                 public object ReadTypedValue ()
 542 #endif
 543                 {
 544                         if (dtdReader == null)
 545                                 return null;
 546                         XmlSchemaDatatype dt = schemaInfo.SchemaType as XmlSchemaDatatype;
 547                         if (dt == null)
 548                                 return null;
 549                         switch (NodeType) {
 550                         case XmlNodeType.Element:
 551                                 if (IsEmptyElement)
 552                                         return null;
 553
 554                                 storedCharacters.Length = 0;
 555                                 bool loop = true;
 556                                 do {
 557                                         Read ();
 558                                         switch (NodeType) {
 559                                         case XmlNodeType.SignificantWhitespace:
 560                                         case XmlNodeType.Text:
 561                                         case XmlNodeType.CDATA:
 562                                                 storedCharacters.Append (Value);
 563                                                 break;
 564                                         case XmlNodeType.Comment:
 565                                                 break;
 566                                         default:
 567                                                 loop = false;
 568                                                 break;
 569                                         }
 570                                 } while (loop && !EOF);
 571                                 return dt.ParseValue (storedCharacters.ToString (), NameTable, dtdReader.ParserContext.NamespaceManager);
 572                         case XmlNodeType.Attribute:
 573                                 return dt.ParseValue (Value, NameTable, dtdReader.ParserContext.NamespaceManager);
 574                         }
 575                         return null;
 576                 }
 577
 578                 public override void ResolveEntity ()
 579                 {
 580                         validatingReader.ResolveEntity ();
 581                 }
 582
 583                 // It should be "protected" as usual "event model"
 584                 // methods are, but validation event is not exposed,
 585                 // so it is no other way to make it "internal".
 586                 internal void OnValidationEvent (object o, ValidationEventArgs e)
 587                 {
 588                         if (ValidationEventHandler != null)
 589                                 ValidationEventHandler (o, e);
 590                         else if (ValidationType != ValidationType.None && e.Severity == XmlSeverityType.Error)
 591                                 throw e.Exception;
 592                 }
 593                 #endregion // Methods
 594
 595                 #region Events and Delegates
 596
 597                 public event ValidationEventHandler ValidationEventHandler;
 598
 599                 #endregion // Events and Delegates
 600         }
 601 }