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

   1 // System.Xml.XmlUrlResolver.cs
   2 //
   3 // Author: Duncan Mak (duncan@ximian.com)
   4 //         Atsushi Enomoto (ginga@kit.hi-ho.ne.jp)
   5 //
   6 // (C) Ximian, Inc.
   7 //
   8
   9 //
  10 // Permission is hereby granted, free of charge, to any person obtaining
  11 // a copy of this software and associated documentation files (the
  12 // "Software"), to deal in the Software without restriction, including
  13 // without limitation the rights to use, copy, modify, merge, publish,
  14 // distribute, sublicense, and/or sell copies of the Software, and to
  15 // permit persons to whom the Software is furnished to do so, subject to
  16 // the following conditions:
  17 //
  18 // The above copyright notice and this permission notice shall be
  19 // included in all copies or substantial portions of the Software.
  20 //
  21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  22 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  24 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  25 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  26 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  27 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  28 //
  29
  30 using System.Net;
  31 using System.IO;
  32 using System.Text;
  33 #if NET_4_5
  34 using System.Net.Cache;
  35 using System.Threading.Tasks;
  36 #endif
  37
  38 namespace System.Xml
  39 {
  40         public class XmlUrlResolver : XmlResolver
  41         {
  42                 // Field
  43                 ICredentials credential;
  44 #if NET_4_5
  45                 RequestCachePolicy cachePolicy;
  46                 IWebProxy proxy;
  47 #endif
  48
  49                 // Constructor
  50                 public XmlUrlResolver ()
  51                         : base ()
  52                 {
  53                 }
  54
  55                 // Properties
  56                 public override ICredentials Credentials
  57                 {
  58                         set { credential = value; }
  59                 }
  60
  61 #if NET_4_5
  62                 public RequestCachePolicy CachePolicy {
  63                         set { cachePolicy = value; }
  64                 }
  65
  66                 public IWebProxy Proxy {
  67                         set { proxy = value; }
  68                 }
  69 #endif
  70
  71                 // Methods
  72                 public override object GetEntity (Uri absoluteUri, string role, Type ofObjectToReturn)
  73                 {
  74                         if (ofObjectToReturn == null)
  75                                 ofObjectToReturn = typeof (Stream);
  76                         if (ofObjectToReturn != typeof (Stream))
  77                                 throw new XmlException ("This object type is not supported.");
  78
  79 #if NET_2_0
  80                         if (!absoluteUri.IsAbsoluteUri)
  81                                 throw new ArgumentException ("uri must be absolute.", "absoluteUri");
  82 #endif
  83
  84                         if (absoluteUri.Scheme == "file") {
  85                                 if (absoluteUri.AbsolutePath == String.Empty)
  86                                         throw new ArgumentException ("uri must be absolute.", "absoluteUri");
  87                                 return new FileStream (UnescapeRelativeUriBody (absoluteUri.LocalPath), FileMode.Open, FileAccess.Read, FileShare.Read);
  88                         }
  89
  90                         // (MS documentation says) parameter role isn't used yet.
  91                         WebRequest req = WebRequest.Create (absoluteUri);
  92 #if NET_4_5
  93                         if (cachePolicy != null)
  94                                 req.CachePolicy = cachePolicy;
  95                         if (proxy != null)
  96                                 req.Proxy = proxy;
  97 #endif
  98                         if (credential != null)
  99                                 req.Credentials = credential;
 100                         return req.GetResponse().GetResponseStream();
 101                 }
 102
 103 #if NET_2_0
 104                 public override Uri ResolveUri (Uri baseUri, string relativeUri)
 105                 {
 106                         return base.ResolveUri (baseUri, relativeUri);
 107                 }
 108 #endif
 109
 110                 // see also XmlResolver.EscapeRelativeUriBody().
 111                 private string UnescapeRelativeUriBody (string src)
 112                 {
 113                         return src.Replace ("%3C", "<")
 114                                 .Replace ("%3E", ">")
 115                                 .Replace ("%23", "#")
 116                                 .Replace ("%22", "\"")
 117                                 .Replace ("%20", " ")
 118                                 .Replace ("%25", "%");
 119                 }
 120
 121 #if NET_4_5
 122                 public override async Task<object> GetEntityAsync (
 123                         Uri absoluteUri, string role, Type ofObjectToReturn)
 124                 {
 125                         if (ofObjectToReturn == null)
 126                                 ofObjectToReturn = typeof (Stream);
 127                         if (ofObjectToReturn != typeof (Stream))
 128                                 throw new XmlException ("This object type is not supported.");
 129
 130                         if (!absoluteUri.IsAbsoluteUri)
 131                                 throw new ArgumentException ("uri must be absolute.", "absoluteUri");
 132
 133                         if (absoluteUri.Scheme == "file") {
 134                                 if (absoluteUri.AbsolutePath == String.Empty)
 135                                         throw new ArgumentException ("uri must be absolute.", "absoluteUri");
 136                                 return new FileStream (UnescapeRelativeUriBody (absoluteUri.LocalPath), FileMode.Open, FileAccess.Read, FileShare.Read);
 137                         }
 138
 139                         // (MS documentation says) parameter role isn't used yet.
 140                         WebRequest req = WebRequest.Create (absoluteUri);
 141                         if (cachePolicy != null)
 142                                 req.CachePolicy = cachePolicy;
 143                         if (proxy != null)
 144                                 req.Proxy = proxy;
 145                         if (credential != null)
 146                                 req.Credentials = credential;
 147                         var res = await req.GetResponseAsync ().ConfigureAwait (false);
 148                         return res.GetResponseStream ();
 149                 }
 150 #endif
 151         }
 152 }