mcs/class/System/System.Net/WebRequest.cs

   1 //
   2 // System.Net.WebRequest
   3 //
   4 // Authors:
   5 //  Lawrence Pit (loz@cable.a2000.nl)
   6 //      Marek Safar (marek.safar@gmail.com)
   7 //
   8 // Copyright 2011 Xamarin Inc.
   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;
  31 using System.Collections;
  32 using System.Collections.Specialized;
  33 using System.Configuration;
  34 using System.IO;
  35 using System.Reflection;
  36 using System.Runtime.Serialization;
  37 using System.Globalization;
  38 using System.Net.Configuration;
  39 using System.Net.Security;
  40 using System.Net.Cache;
  41 using System.Security.Principal;
  42 #if NET_4_5
  43 using System.Threading.Tasks;
  44 #endif
  45
  46 #if NET_2_1
  47 using ConfigurationException = System.ArgumentException;
  48
  49 namespace System.Net.Configuration {
  50         class Dummy {}
  51 }
  52 #endif
  53
  54 namespace System.Net
  55 {
  56         [Serializable]
  57         public abstract class WebRequest : MarshalByRefObject, ISerializable {
  58                 static HybridDictionary prefixes = new HybridDictionary ();
  59                 static bool isDefaultWebProxySet;
  60                 static IWebProxy defaultWebProxy;
  61                 static RequestCachePolicy defaultCachePolicy;
  62
  63                 static WebRequest ()
  64                 {
  65 #if MOBILE
  66                         IWebRequestCreate http = new HttpRequestCreator ();
  67                         RegisterPrefix ("http", http);
  68                         RegisterPrefix ("https", http);
  69                         RegisterPrefix ("file", new FileWebRequestCreator ());
  70                         RegisterPrefix ("ftp", new FtpRequestCreator ());
  71 #else
  72         #if CONFIGURATION_DEP
  73                         object cfg = ConfigurationManager.GetSection ("system.net/webRequestModules");
  74                         WebRequestModulesSection s = cfg as WebRequestModulesSection;
  75                         if (s != null) {
  76                                 foreach (WebRequestModuleElement el in
  77                                          s.WebRequestModules)
  78                                         AddPrefix (el.Prefix, el.Type);
  79                                 return;
  80                         }
  81         #endif
  82                         ConfigurationSettings.GetConfig ("system.net/webRequestModules");
  83 #endif
  84                 }
  85
  86                 protected WebRequest ()
  87                 {
  88                 }
  89
  90                 protected WebRequest (SerializationInfo serializationInfo, StreamingContext streamingContext)
  91                 {
  92                 }
  93
  94                 static Exception GetMustImplement ()
  95                 {
  96                         return new NotImplementedException ("This method must be implemented in derived classes");
  97                 }
  98
  99                 // Properties
 100
 101                 private AuthenticationLevel authentication_level = AuthenticationLevel.MutualAuthRequested;
 102
 103                 public AuthenticationLevel AuthenticationLevel
 104                 {
 105                         get {
 106                                 return(authentication_level);
 107                         }
 108                         set {
 109                                 authentication_level = value;
 110                         }
 111                 }
 112
 113                 public virtual string ConnectionGroupName {
 114                         get { throw GetMustImplement (); }
 115                         set { throw GetMustImplement (); }
 116                 }
 117
 118                 public virtual long ContentLength {
 119                         get { throw GetMustImplement (); }
 120                         set { throw GetMustImplement (); }
 121                 }
 122
 123                 public virtual string ContentType {
 124                         get { throw GetMustImplement (); }
 125                         set { throw GetMustImplement (); }
 126                 }
 127
 128                 public virtual ICredentials Credentials {
 129                         get { throw GetMustImplement (); }
 130                         set { throw GetMustImplement (); }
 131                 }
 132
 133                 [MonoTODO ("Implement the caching system. Currently always returns a policy with the NoCacheNoStore level")]
 134                 public virtual RequestCachePolicy CachePolicy
 135                 {
 136                         get { return DefaultCachePolicy; }
 137                         set {
 138                         }
 139                 }
 140
 141                 public static RequestCachePolicy DefaultCachePolicy {
 142                         get {
 143                                 return defaultCachePolicy ?? (defaultCachePolicy = new HttpRequestCachePolicy (HttpRequestCacheLevel.NoCacheNoStore));
 144                         }
 145                         set {
 146                                 throw GetMustImplement ();
 147                         }
 148                 }
 149
 150                 public virtual WebHeaderCollection Headers {
 151                         get { throw GetMustImplement (); }
 152                         set { throw GetMustImplement (); }
 153                 }
 154
 155                 public TokenImpersonationLevel ImpersonationLevel {
 156                         get { throw GetMustImplement (); }
 157                         set { throw GetMustImplement (); }
 158                 }
 159
 160                 public virtual string Method {
 161                         get { throw GetMustImplement (); }
 162                         set { throw GetMustImplement (); }
 163                 }
 164
 165                 public virtual bool PreAuthenticate {
 166                         get { throw GetMustImplement (); }
 167                         set { throw GetMustImplement (); }
 168                 }
 169
 170                 public virtual IWebProxy Proxy {
 171                         get { throw GetMustImplement (); }
 172                         set { throw GetMustImplement (); }
 173                 }
 174
 175                 public virtual Uri RequestUri {
 176                         get { throw GetMustImplement (); }
 177                 }
 178
 179                 public virtual int Timeout {
 180                         get { throw GetMustImplement (); }
 181                         set { throw GetMustImplement (); }
 182                 }
 183
 184                 public virtual bool UseDefaultCredentials
 185                 {
 186                         get {
 187                                 throw GetMustImplement ();
 188                         }
 189                         set {
 190                                 throw GetMustImplement ();
 191                         }
 192                 }
 193
 194 //              volatile static IWebProxy proxy;
 195                 static readonly object lockobj = new object ();
 196
 197                 public static IWebProxy DefaultWebProxy {
 198                         get {
 199                                 if (!isDefaultWebProxySet) {
 200                                         lock (lockobj) {
 201                                                 if (defaultWebProxy == null)
 202                                                         defaultWebProxy = GetDefaultWebProxy ();
 203                                         }
 204                                 }
 205                                 return defaultWebProxy;
 206                         }
 207                         set {
 208                                 /* MS documentation states that a null value would cause an ArgumentNullException
 209                                  * but that's not the way it behaves:
 210                                  * https://connect.microsoft.com/VisualStudio/feedback/ViewFeedback.aspx?FeedbackID=304724
 211                                  */
 212                                 defaultWebProxy = value;
 213                                 isDefaultWebProxySet = true;
 214                         }
 215                 }
 216
 217                 [MonoTODO("Needs to respect Module, Proxy.AutoDetect, and Proxy.ScriptLocation config settings")]
 218                 static IWebProxy GetDefaultWebProxy ()
 219                 {
 220 #if CONFIGURATION_DEP
 221                         DefaultProxySection sec = ConfigurationManager.GetSection ("system.net/defaultProxy") as DefaultProxySection;
 222                         WebProxy p;
 223
 224                         if (sec == null)
 225                                 return GetSystemWebProxy ();
 226
 227                         ProxyElement pe = sec.Proxy;
 228
 229                         if ((pe.UseSystemDefault != ProxyElement.UseSystemDefaultValues.False) && (pe.ProxyAddress == null)) {
 230                                 IWebProxy proxy = GetSystemWebProxy ();
 231
 232                                 if (!(proxy is WebProxy))
 233                                         return proxy;
 234
 235                                 p = (WebProxy) proxy;
 236                         } else
 237                                 p = new WebProxy ();
 238
 239                         if (pe.ProxyAddress != null)
 240                                 p.Address = pe.ProxyAddress;
 241
 242                         if (pe.BypassOnLocal != ProxyElement.BypassOnLocalValues.Unspecified)
 243                                 p.BypassProxyOnLocal = (pe.BypassOnLocal == ProxyElement.BypassOnLocalValues.True);
 244
 245                         foreach(BypassElement elem in sec.BypassList)
 246                                 p.BypassArrayList.Add(elem.Address);
 247
 248                         return p;
 249 #else
 250                         return GetSystemWebProxy ();
 251 #endif
 252                 }
 253
 254                 // Methods
 255
 256                 public virtual void Abort()
 257                 {
 258                         throw GetMustImplement ();
 259                 }
 260
 261                 public virtual IAsyncResult BeginGetRequestStream (AsyncCallback callback, object state)
 262                 {
 263                         throw GetMustImplement ();
 264                 }
 265
 266                 public virtual IAsyncResult BeginGetResponse (AsyncCallback callback, object state)
 267                 {
 268                         throw GetMustImplement ();
 269                 }
 270
 271                 public static WebRequest Create (string requestUriString)
 272                 {
 273                         if (requestUriString == null)
 274                                 throw new ArgumentNullException ("requestUriString");
 275                         return Create (new Uri (requestUriString));
 276                 }
 277
 278                 public static WebRequest Create (Uri requestUri)
 279                 {
 280                         if (requestUri == null)
 281                                 throw new ArgumentNullException ("requestUri");
 282                         return GetCreator (requestUri.AbsoluteUri).Create (requestUri);
 283                 }
 284
 285                 public static WebRequest CreateDefault (Uri requestUri)
 286                 {
 287                         if (requestUri == null)
 288                                 throw new ArgumentNullException ("requestUri");
 289                         return GetCreator (requestUri.Scheme).Create (requestUri);
 290                 }
 291 #if NET_4_0
 292                 [MonoTODO ("for portable library support")]
 293                 public static HttpWebRequest CreateHttp (string requestUriString)
 294                 {
 295                         throw new NotImplementedException ();
 296                 }
 297
 298                 [MonoTODO ("for portable library support")]
 299                 public static HttpWebRequest CreateHttp (Uri requestUri)
 300                 {
 301                         throw new NotImplementedException ();
 302                 }
 303 #endif
 304                 public virtual Stream EndGetRequestStream (IAsyncResult asyncResult)
 305                 {
 306                         throw GetMustImplement ();
 307                 }
 308
 309                 public virtual WebResponse EndGetResponse (IAsyncResult asyncResult)
 310                 {
 311                         throw GetMustImplement ();
 312                 }
 313
 314                 public virtual Stream GetRequestStream()
 315                 {
 316                         throw GetMustImplement ();
 317                 }
 318
 319                 public virtual WebResponse GetResponse()
 320                 {
 321                         throw GetMustImplement ();
 322                 }
 323
 324                 [MonoTODO("Look in other places for proxy config info")]
 325                 public static IWebProxy GetSystemWebProxy ()
 326                 {
 327 #if MONOTOUCH
 328                         return CFNetwork.GetDefaultProxy ();
 329 #else
 330 #if MONODROID
 331                         // Return the system web proxy.  This only works for ICS+.
 332                         var androidProxy = AndroidPlatform.GetDefaultProxy ();
 333                         if (androidProxy != null)
 334                                 return androidProxy;
 335 #endif
 336 #if !NET_2_1
 337                         if (IsWindows ()) {
 338                                 int iProxyEnable = (int)Microsoft.Win32.Registry.GetValue ("HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings", "ProxyEnable", 0);
 339
 340                                 if (iProxyEnable > 0) {
 341                                         string strHttpProxy = "";
 342                                         bool bBypassOnLocal = false;
 343                                         ArrayList al = new ArrayList ();
 344
 345                                         string strProxyServer = (string)Microsoft.Win32.Registry.GetValue ("HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings", "ProxyServer", null);
 346                                         string strProxyOverrride = (string)Microsoft.Win32.Registry.GetValue ("HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings", "ProxyOverride", null);
 347
 348                                         if (strProxyServer.Contains ("=")) {
 349                                                 foreach (string strEntry in strProxyServer.Split (new char[] { ';' }, StringSplitOptions.RemoveEmptyEntries))
 350                                                         if (strEntry.StartsWith ("http=")) {
 351                                                                 strHttpProxy = strEntry.Substring (5);
 352                                                                 break;
 353                                                         }
 354                                         } else strHttpProxy = strProxyServer;
 355
 356                                         if (strProxyOverrride != null) {
 357                                                 string[] bypassList = strProxyOverrride.Split (new char[] { ';' }, StringSplitOptions.RemoveEmptyEntries);
 358
 359                                                 foreach (string str in bypassList) {
 360                                                         if (str != "<local>")
 361                                                                 al.Add (str);
 362                                                         else
 363                                                                 bBypassOnLocal = true;
 364                                                 }
 365                                         }
 366
 367                                         return new WebProxy (strHttpProxy, bBypassOnLocal, al.ToArray (typeof(string)) as string[]);
 368                                 }
 369                         } else {
 370 #endif
 371                                 if (Platform.IsMacOS)
 372                                         return CFNetwork.GetDefaultProxy ();
 373
 374                                 string address = Environment.GetEnvironmentVariable ("http_proxy");
 375
 376                                 if (address == null)
 377                                         address = Environment.GetEnvironmentVariable ("HTTP_PROXY");
 378
 379                                 if (address != null) {
 380                                         try {
 381                                                 if (!address.StartsWith ("http://"))
 382                                                         address = "http://" + address;
 383
 384                                                 Uri uri = new Uri (address);
 385                                                 IPAddress ip;
 386
 387                                                 if (IPAddress.TryParse (uri.Host, out ip)) {
 388                                                         if (IPAddress.Any.Equals (ip)) {
 389                                                                 UriBuilder builder = new UriBuilder (uri);
 390                                                                 builder.Host = "127.0.0.1";
 391                                                                 uri = builder.Uri;
 392                                                         } else if (IPAddress.IPv6Any.Equals (ip)) {
 393                                                                 UriBuilder builder = new UriBuilder (uri);
 394                                                                 builder.Host = "[::1]";
 395                                                                 uri = builder.Uri;
 396                                                         }
 397                                                 }
 398
 399                                                 bool bBypassOnLocal = false;
 400                                                 ArrayList al = new ArrayList ();
 401                                                 string bypass = Environment.GetEnvironmentVariable ("no_proxy");
 402
 403                                                 if (bypass == null)
 404                                                         bypass = Environment.GetEnvironmentVariable ("NO_PROXY");
 405
 406                                                 if (bypass != null) {
 407                                                         string[] bypassList = bypass.Split (new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
 408
 409                                                         foreach (string str in bypassList) {
 410                                                                 if (str != "*.local")
 411                                                                         al.Add (str);
 412                                                                 else
 413                                                                         bBypassOnLocal = true;
 414                                                         }
 415                                                 }
 416
 417                                                 return new WebProxy (uri, bBypassOnLocal, al.ToArray (typeof(string)) as string[]);
 418                                         } catch (UriFormatException) {
 419                                         }
 420                                 }
 421 #if !NET_2_1
 422                         }
 423 #endif
 424
 425                         return new WebProxy ();
 426 #endif // MONOTOUCH
 427                 }
 428
 429                 void ISerializable.GetObjectData (SerializationInfo serializationInfo, StreamingContext streamingContext)
 430                 {
 431                         throw new NotSupportedException ();
 432                 }
 433
 434                 protected virtual void GetObjectData (SerializationInfo serializationInfo, StreamingContext streamingContext)
 435                 {
 436                         throw GetMustImplement ();
 437                 }
 438
 439                 public static bool RegisterPrefix (string prefix, IWebRequestCreate creator)
 440                 {
 441                         if (prefix == null)
 442                                 throw new ArgumentNullException ("prefix");
 443                         if (creator == null)
 444                                 throw new ArgumentNullException ("creator");
 445
 446                         lock (prefixes.SyncRoot) {
 447                                 string lowerCasePrefix = prefix.ToLower (CultureInfo.InvariantCulture);
 448                                 if (prefixes.Contains (lowerCasePrefix))
 449                                         return false;
 450                                 prefixes.Add (lowerCasePrefix, creator);
 451                         }
 452                         return true;
 453                 }
 454
 455                 private static IWebRequestCreate GetCreator (string prefix)
 456                 {
 457                         int longestPrefix = -1;
 458                         IWebRequestCreate creator = null;
 459
 460                         prefix = prefix.ToLower (CultureInfo.InvariantCulture);
 461
 462                         IDictionaryEnumerator e = prefixes.GetEnumerator ();
 463                         while (e.MoveNext ()) {
 464                                 string key = e.Key as string;
 465
 466                                 if (key.Length <= longestPrefix)
 467                                         continue;
 468
 469                                 if (!prefix.StartsWith (key))
 470                                         continue;
 471
 472                                 longestPrefix = key.Length;
 473                                 creator = (IWebRequestCreate) e.Value;
 474                         }
 475
 476                         if (creator == null)
 477                                 throw new NotSupportedException (prefix);
 478
 479                         return creator;
 480                 }
 481
 482                 internal static bool IsWindows ()
 483                 {
 484                         return (int) Environment.OSVersion.Platform < 4;
 485                 }
 486
 487                 internal static void ClearPrefixes ()
 488                 {
 489                         prefixes.Clear ();
 490                 }
 491
 492                 internal static void RemovePrefix (string prefix)
 493                 {
 494                         prefixes.Remove (prefix);
 495                 }
 496
 497                 internal static void AddPrefix (string prefix, string typeName)
 498                 {
 499                         Type type = Type.GetType (typeName);
 500                         if (type == null)
 501                                 throw new ConfigurationException (String.Format ("Type {0} not found", typeName));
 502                         AddPrefix (prefix, type);
 503                 }
 504
 505                 internal static void AddPrefix (string prefix, Type type)
 506                 {
 507                         object o = Activator.CreateInstance (type, true);
 508                         prefixes [prefix] = o;
 509                 }
 510
 511 #if NET_4_5
 512                 public virtual Task<Stream> GetRequestStreamAsync ()
 513                 {
 514                         return Task<Stream>.Factory.FromAsync (BeginGetRequestStream, EndGetRequestStream, null);
 515                 }
 516
 517                 public virtual Task<WebResponse> GetResponseAsync ()
 518                 {
 519                         return Task<WebResponse>.Factory.FromAsync (BeginGetResponse, EndGetResponse, null);
 520                 }
 521 #endif
 522
 523         }
 524 }