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
 156                 public virtual string Method {
 157                         get { throw GetMustImplement (); }
 158                         set { throw GetMustImplement (); }
 159                 }
 160
 161                 public virtual bool PreAuthenticate {
 162                         get { throw GetMustImplement (); }
 163                         set { throw GetMustImplement (); }
 164                 }
 165
 166                 public virtual IWebProxy Proxy {
 167                         get { throw GetMustImplement (); }
 168                         set { throw GetMustImplement (); }
 169                 }
 170
 171                 public virtual Uri RequestUri {
 172                         get { throw GetMustImplement (); }
 173                 }
 174
 175                 public virtual int Timeout {
 176                         get { throw GetMustImplement (); }
 177                         set { throw GetMustImplement (); }
 178                 }
 179
 180                 public virtual bool UseDefaultCredentials
 181                 {
 182                         get {
 183                                 throw GetMustImplement ();
 184                         }
 185                         set {
 186                                 throw GetMustImplement ();
 187                         }
 188                 }
 189
 190                 public TokenImpersonationLevel ImpersonationLevel { get; set; }
 191
 192 //              volatile static IWebProxy proxy;
 193                 static readonly object lockobj = new object ();
 194
 195                 public static IWebProxy DefaultWebProxy {
 196                         get {
 197                                 if (!isDefaultWebProxySet) {
 198                                         lock (lockobj) {
 199                                                 if (defaultWebProxy == null)
 200                                                         defaultWebProxy = GetDefaultWebProxy ();
 201                                         }
 202                                 }
 203                                 return defaultWebProxy;
 204                         }
 205                         set {
 206                                 /* MS documentation states that a null value would cause an ArgumentNullException
 207                                  * but that's not the way it behaves:
 208                                  * https://connect.microsoft.com/VisualStudio/feedback/ViewFeedback.aspx?FeedbackID=304724
 209                                  */
 210                                 defaultWebProxy = value;
 211                                 isDefaultWebProxySet = true;
 212                         }
 213                 }
 214
 215                 [MonoTODO("Needs to respect Module, Proxy.AutoDetect, and Proxy.ScriptLocation config settings")]
 216                 static IWebProxy GetDefaultWebProxy ()
 217                 {
 218 #if CONFIGURATION_DEP
 219                         DefaultProxySection sec = ConfigurationManager.GetSection ("system.net/defaultProxy") as DefaultProxySection;
 220                         WebProxy p;
 221
 222                         if (sec == null)
 223                                 return GetSystemWebProxy ();
 224
 225                         ProxyElement pe = sec.Proxy;
 226
 227                         if ((pe.UseSystemDefault != ProxyElement.UseSystemDefaultValues.False) && (pe.ProxyAddress == null)) {
 228                                 IWebProxy proxy = GetSystemWebProxy ();
 229
 230                                 if (!(proxy is WebProxy))
 231                                         return proxy;
 232
 233                                 p = (WebProxy) proxy;
 234                         } else
 235                                 p = new WebProxy ();
 236
 237                         if (pe.ProxyAddress != null)
 238                                 p.Address = pe.ProxyAddress;
 239
 240                         if (pe.BypassOnLocal != ProxyElement.BypassOnLocalValues.Unspecified)
 241                                 p.BypassProxyOnLocal = (pe.BypassOnLocal == ProxyElement.BypassOnLocalValues.True);
 242
 243                         foreach(BypassElement elem in sec.BypassList)
 244                                 p.BypassArrayList.Add(elem.Address);
 245
 246                         return p;
 247 #else
 248                         return GetSystemWebProxy ();
 249 #endif
 250                 }
 251
 252                 // Methods
 253
 254                 public virtual void Abort()
 255                 {
 256                         throw GetMustImplement ();
 257                 }
 258
 259                 public virtual IAsyncResult BeginGetRequestStream (AsyncCallback callback, object state)
 260                 {
 261                         throw GetMustImplement ();
 262                 }
 263
 264                 public virtual IAsyncResult BeginGetResponse (AsyncCallback callback, object state)
 265                 {
 266                         throw GetMustImplement ();
 267                 }
 268
 269                 public static WebRequest Create (string requestUriString)
 270                 {
 271                         if (requestUriString == null)
 272                                 throw new ArgumentNullException ("requestUriString");
 273                         return Create (new Uri (requestUriString));
 274                 }
 275
 276                 public static WebRequest Create (Uri requestUri)
 277                 {
 278                         if (requestUri == null)
 279                                 throw new ArgumentNullException ("requestUri");
 280                         return GetCreator (requestUri.AbsoluteUri).Create (requestUri);
 281                 }
 282
 283                 public static WebRequest CreateDefault (Uri requestUri)
 284                 {
 285                         if (requestUri == null)
 286                                 throw new ArgumentNullException ("requestUri");
 287                         return GetCreator (requestUri.Scheme).Create (requestUri);
 288                 }
 289 #if NET_4_0
 290                 static HttpWebRequest SharedCreateHttp (Uri uri)
 291                 {
 292                         if (uri.Scheme != "http" && uri.Scheme != "https")
 293                                 throw new NotSupportedException ("The uri should start with http or https");
 294
 295                         return new HttpWebRequest (uri);
 296                 }
 297
 298                 public static HttpWebRequest CreateHttp (string requestUriString)
 299                 {
 300                         if (requestUriString == null)
 301                                 throw new ArgumentNullException ("requestUriString");
 302                         return SharedCreateHttp (new Uri (requestUriString));
 303                 }
 304
 305                 public static HttpWebRequest CreateHttp (Uri requestUri)
 306                 {
 307                         if (requestUri == null)
 308                                 throw new ArgumentNullException ("requestUri");
 309                         return SharedCreateHttp (requestUri);
 310                 }
 311 #endif
 312                 public virtual Stream EndGetRequestStream (IAsyncResult asyncResult)
 313                 {
 314                         throw GetMustImplement ();
 315                 }
 316
 317                 public virtual WebResponse EndGetResponse (IAsyncResult asyncResult)
 318                 {
 319                         throw GetMustImplement ();
 320                 }
 321
 322                 public virtual Stream GetRequestStream()
 323                 {
 324                         throw GetMustImplement ();
 325                 }
 326
 327                 public virtual WebResponse GetResponse()
 328                 {
 329                         throw GetMustImplement ();
 330                 }
 331
 332                 [MonoTODO("Look in other places for proxy config info")]
 333                 public static IWebProxy GetSystemWebProxy ()
 334                 {
 335 #if MONOTOUCH
 336                         return CFNetwork.GetDefaultProxy ();
 337 #else
 338 #if MONODROID
 339                         // Return the system web proxy.  This only works for ICS+.
 340                         var androidProxy = AndroidPlatform.GetDefaultProxy ();
 341                         if (androidProxy != null)
 342                                 return androidProxy;
 343 #endif
 344 #if !NET_2_1
 345                         if (IsWindows ()) {
 346                                 int iProxyEnable = (int)Microsoft.Win32.Registry.GetValue ("HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings", "ProxyEnable", 0);
 347
 348                                 if (iProxyEnable > 0) {
 349                                         string strHttpProxy = "";
 350                                         bool bBypassOnLocal = false;
 351                                         ArrayList al = new ArrayList ();
 352
 353                                         string strProxyServer = (string)Microsoft.Win32.Registry.GetValue ("HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings", "ProxyServer", null);
 354                                         string strProxyOverrride = (string)Microsoft.Win32.Registry.GetValue ("HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings", "ProxyOverride", null);
 355
 356                                         if (strProxyServer.Contains ("=")) {
 357                                                 foreach (string strEntry in strProxyServer.Split (new char[] { ';' }, StringSplitOptions.RemoveEmptyEntries))
 358                                                         if (strEntry.StartsWith ("http=")) {
 359                                                                 strHttpProxy = strEntry.Substring (5);
 360                                                                 break;
 361                                                         }
 362                                         } else strHttpProxy = strProxyServer;
 363
 364                                         if (strProxyOverrride != null) {
 365                                                 string[] bypassList = strProxyOverrride.Split (new char[] { ';' }, StringSplitOptions.RemoveEmptyEntries);
 366
 367                                                 foreach (string str in bypassList) {
 368                                                         if (str != "<local>")
 369                                                                 al.Add (str);
 370                                                         else
 371                                                                 bBypassOnLocal = true;
 372                                                 }
 373                                         }
 374
 375                                         return new WebProxy (strHttpProxy, bBypassOnLocal, al.ToArray (typeof(string)) as string[]);
 376                                 }
 377                         } else {
 378 #endif
 379                                 if (Platform.IsMacOS)
 380                                         return CFNetwork.GetDefaultProxy ();
 381
 382                                 string address = Environment.GetEnvironmentVariable ("http_proxy");
 383
 384                                 if (address == null)
 385                                         address = Environment.GetEnvironmentVariable ("HTTP_PROXY");
 386
 387                                 if (address != null) {
 388                                         try {
 389                                                 if (!address.StartsWith ("http://"))
 390                                                         address = "http://" + address;
 391
 392                                                 Uri uri = new Uri (address);
 393                                                 IPAddress ip;
 394
 395                                                 if (IPAddress.TryParse (uri.Host, out ip)) {
 396                                                         if (IPAddress.Any.Equals (ip)) {
 397                                                                 UriBuilder builder = new UriBuilder (uri);
 398                                                                 builder.Host = "127.0.0.1";
 399                                                                 uri = builder.Uri;
 400                                                         } else if (IPAddress.IPv6Any.Equals (ip)) {
 401                                                                 UriBuilder builder = new UriBuilder (uri);
 402                                                                 builder.Host = "[::1]";
 403                                                                 uri = builder.Uri;
 404                                                         }
 405                                                 }
 406
 407                                                 bool bBypassOnLocal = false;
 408                                                 ArrayList al = new ArrayList ();
 409                                                 string bypass = Environment.GetEnvironmentVariable ("no_proxy");
 410
 411                                                 if (bypass == null)
 412                                                         bypass = Environment.GetEnvironmentVariable ("NO_PROXY");
 413
 414                                                 if (bypass != null) {
 415                                                         string[] bypassList = bypass.Split (new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
 416
 417                                                         foreach (string str in bypassList) {
 418                                                                 if (str != "*.local")
 419                                                                         al.Add (str);
 420                                                                 else
 421                                                                         bBypassOnLocal = true;
 422                                                         }
 423                                                 }
 424
 425                                                 return new WebProxy (uri, bBypassOnLocal, al.ToArray (typeof(string)) as string[]);
 426                                         } catch (UriFormatException) {
 427                                         }
 428                                 }
 429 #if !NET_2_1
 430                         }
 431 #endif
 432
 433                         return new WebProxy ();
 434 #endif // MONOTOUCH
 435                 }
 436
 437                 void ISerializable.GetObjectData (SerializationInfo serializationInfo, StreamingContext streamingContext)
 438                 {
 439                         throw new NotSupportedException ();
 440                 }
 441
 442                 protected virtual void GetObjectData (SerializationInfo serializationInfo, StreamingContext streamingContext)
 443                 {
 444                         throw GetMustImplement ();
 445                 }
 446
 447                 public static bool RegisterPrefix (string prefix, IWebRequestCreate creator)
 448                 {
 449                         if (prefix == null)
 450                                 throw new ArgumentNullException ("prefix");
 451                         if (creator == null)
 452                                 throw new ArgumentNullException ("creator");
 453
 454                         lock (prefixes.SyncRoot) {
 455                                 string lowerCasePrefix = prefix.ToLower (CultureInfo.InvariantCulture);
 456                                 if (prefixes.Contains (lowerCasePrefix))
 457                                         return false;
 458                                 prefixes.Add (lowerCasePrefix, creator);
 459                         }
 460                         return true;
 461                 }
 462
 463                 private static IWebRequestCreate GetCreator (string prefix)
 464                 {
 465                         int longestPrefix = -1;
 466                         IWebRequestCreate creator = null;
 467
 468                         prefix = prefix.ToLower (CultureInfo.InvariantCulture);
 469
 470                         IDictionaryEnumerator e = prefixes.GetEnumerator ();
 471                         while (e.MoveNext ()) {
 472                                 string key = e.Key as string;
 473
 474                                 if (key.Length <= longestPrefix)
 475                                         continue;
 476
 477                                 if (!prefix.StartsWith (key))
 478                                         continue;
 479
 480                                 longestPrefix = key.Length;
 481                                 creator = (IWebRequestCreate) e.Value;
 482                         }
 483
 484                         if (creator == null)
 485                                 throw new NotSupportedException (prefix);
 486
 487                         return creator;
 488                 }
 489
 490                 internal static bool IsWindows ()
 491                 {
 492                         return (int) Environment.OSVersion.Platform < 4;
 493                 }
 494
 495                 internal static void ClearPrefixes ()
 496                 {
 497                         prefixes.Clear ();
 498                 }
 499
 500                 internal static void RemovePrefix (string prefix)
 501                 {
 502                         prefixes.Remove (prefix);
 503                 }
 504
 505                 internal static void AddPrefix (string prefix, string typeName)
 506                 {
 507                         Type type = Type.GetType (typeName);
 508                         if (type == null)
 509                                 throw new ConfigurationException (String.Format ("Type {0} not found", typeName));
 510                         AddPrefix (prefix, type);
 511                 }
 512
 513                 internal static void AddPrefix (string prefix, Type type)
 514                 {
 515                         object o = Activator.CreateInstance (type, true);
 516                         prefixes [prefix] = o;
 517                 }
 518
 519 #if NET_4_5
 520                 public virtual Task<Stream> GetRequestStreamAsync ()
 521                 {
 522                         return Task<Stream>.Factory.FromAsync (BeginGetRequestStream, EndGetRequestStream, null);
 523                 }
 524
 525                 public virtual Task<WebResponse> GetResponseAsync ()
 526                 {
 527                         return Task<WebResponse>.Factory.FromAsync (BeginGetResponse, EndGetResponse, null);
 528                 }
 529 #endif
 530
 531         }
 532 }