2 // System.Net.WebRequest
5 // Lawrence Pit (loz@cable.a2000.nl)
6 // Marek Safar (marek.safar@gmail.com)
8 // Copyright 2011 Xamarin Inc.
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:
18 // The above copyright notice and this permission notice shall be
19 // included in all copies or substantial portions of the Software.
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.
31 using System.Collections;
32 using System.Collections.Specialized;
33 using System.Configuration;
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;
43 using System.Threading.Tasks;
47 using ConfigurationException = System.ArgumentException;
49 namespace System.Net.Configuration {
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;
66 IWebRequestCreate http = new HttpRequestCreator ();
67 RegisterPrefix ("http", http);
68 RegisterPrefix ("https", http);
69 RegisterPrefix ("file", new FileWebRequestCreator ());
70 RegisterPrefix ("ftp", new FtpRequestCreator ());
73 object cfg = ConfigurationManager.GetSection ("system.net/webRequestModules");
74 WebRequestModulesSection s = cfg as WebRequestModulesSection;
76 foreach (WebRequestModuleElement el in
78 AddPrefix (el.Prefix, el.Type);
82 ConfigurationSettings.GetConfig ("system.net/webRequestModules");
86 protected WebRequest ()
90 protected WebRequest (SerializationInfo serializationInfo, StreamingContext streamingContext)
94 static Exception GetMustImplement ()
96 return new NotImplementedException ("This method must be implemented in derived classes");
101 private AuthenticationLevel authentication_level = AuthenticationLevel.MutualAuthRequested;
103 public AuthenticationLevel AuthenticationLevel
106 return(authentication_level);
109 authentication_level = value;
113 public virtual string ConnectionGroupName {
114 get { throw GetMustImplement (); }
115 set { throw GetMustImplement (); }
118 public virtual long ContentLength {
119 get { throw GetMustImplement (); }
120 set { throw GetMustImplement (); }
123 public virtual string ContentType {
124 get { throw GetMustImplement (); }
125 set { throw GetMustImplement (); }
128 public virtual ICredentials Credentials {
129 get { throw GetMustImplement (); }
130 set { throw GetMustImplement (); }
133 [MonoTODO ("Implement the caching system. Currently always returns a policy with the NoCacheNoStore level")]
134 public virtual RequestCachePolicy CachePolicy
136 get { return DefaultCachePolicy; }
141 public static RequestCachePolicy DefaultCachePolicy {
143 return defaultCachePolicy ?? (defaultCachePolicy = new HttpRequestCachePolicy (HttpRequestCacheLevel.NoCacheNoStore));
146 throw GetMustImplement ();
150 public virtual WebHeaderCollection Headers {
151 get { throw GetMustImplement (); }
152 set { throw GetMustImplement (); }
156 public virtual string Method {
157 get { throw GetMustImplement (); }
158 set { throw GetMustImplement (); }
161 public virtual bool PreAuthenticate {
162 get { throw GetMustImplement (); }
163 set { throw GetMustImplement (); }
166 public virtual IWebProxy Proxy {
167 get { throw GetMustImplement (); }
168 set { throw GetMustImplement (); }
171 public virtual Uri RequestUri {
172 get { throw GetMustImplement (); }
175 public virtual int Timeout {
176 get { throw GetMustImplement (); }
177 set { throw GetMustImplement (); }
180 public virtual bool UseDefaultCredentials
183 throw GetMustImplement ();
186 throw GetMustImplement ();
190 public TokenImpersonationLevel ImpersonationLevel { get; set; }
192 // volatile static IWebProxy proxy;
193 static readonly object lockobj = new object ();
195 public static IWebProxy DefaultWebProxy {
197 if (!isDefaultWebProxySet) {
199 if (defaultWebProxy == null)
200 defaultWebProxy = GetDefaultWebProxy ();
203 return defaultWebProxy;
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
210 defaultWebProxy = value;
211 isDefaultWebProxySet = true;
215 [MonoTODO("Needs to respect Module, Proxy.AutoDetect, and Proxy.ScriptLocation config settings")]
216 static IWebProxy GetDefaultWebProxy ()
218 #if CONFIGURATION_DEP
219 DefaultProxySection sec = ConfigurationManager.GetSection ("system.net/defaultProxy") as DefaultProxySection;
223 return GetSystemWebProxy ();
225 ProxyElement pe = sec.Proxy;
227 if ((pe.UseSystemDefault != ProxyElement.UseSystemDefaultValues.False) && (pe.ProxyAddress == null)) {
228 IWebProxy proxy = GetSystemWebProxy ();
230 if (!(proxy is WebProxy))
233 p = (WebProxy) proxy;
237 if (pe.ProxyAddress != null)
238 p.Address = pe.ProxyAddress;
240 if (pe.BypassOnLocal != ProxyElement.BypassOnLocalValues.Unspecified)
241 p.BypassProxyOnLocal = (pe.BypassOnLocal == ProxyElement.BypassOnLocalValues.True);
243 foreach(BypassElement elem in sec.BypassList)
244 p.BypassArrayList.Add(elem.Address);
248 return GetSystemWebProxy ();
254 public virtual void Abort()
256 throw GetMustImplement ();
259 public virtual IAsyncResult BeginGetRequestStream (AsyncCallback callback, object state)
261 throw GetMustImplement ();
264 public virtual IAsyncResult BeginGetResponse (AsyncCallback callback, object state)
266 throw GetMustImplement ();
269 public static WebRequest Create (string requestUriString)
271 if (requestUriString == null)
272 throw new ArgumentNullException ("requestUriString");
273 return Create (new Uri (requestUriString));
276 public static WebRequest Create (Uri requestUri)
278 if (requestUri == null)
279 throw new ArgumentNullException ("requestUri");
280 return GetCreator (requestUri.AbsoluteUri).Create (requestUri);
283 public static WebRequest CreateDefault (Uri requestUri)
285 if (requestUri == null)
286 throw new ArgumentNullException ("requestUri");
287 return GetCreator (requestUri.Scheme).Create (requestUri);
290 static HttpWebRequest SharedCreateHttp (Uri uri)
292 if (uri.Scheme != "http" && uri.Scheme != "https")
293 throw new NotSupportedException ("The uri should start with http or https");
295 return new HttpWebRequest (uri);
298 public static HttpWebRequest CreateHttp (string requestUriString)
300 if (requestUriString == null)
301 throw new ArgumentNullException ("requestUriString");
302 return SharedCreateHttp (new Uri (requestUriString));
305 public static HttpWebRequest CreateHttp (Uri requestUri)
307 if (requestUri == null)
308 throw new ArgumentNullException ("requestUri");
309 return SharedCreateHttp (requestUri);
312 public virtual Stream EndGetRequestStream (IAsyncResult asyncResult)
314 throw GetMustImplement ();
317 public virtual WebResponse EndGetResponse (IAsyncResult asyncResult)
319 throw GetMustImplement ();
322 public virtual Stream GetRequestStream()
324 throw GetMustImplement ();
327 public virtual WebResponse GetResponse()
329 throw GetMustImplement ();
332 [MonoTODO("Look in other places for proxy config info")]
333 public static IWebProxy GetSystemWebProxy ()
336 return CFNetwork.GetDefaultProxy ();
339 // Return the system web proxy. This only works for ICS+.
340 var androidProxy = AndroidPlatform.GetDefaultProxy ();
341 if (androidProxy != null)
346 int iProxyEnable = (int)Microsoft.Win32.Registry.GetValue ("HKEY_CURRENT_USER\\Software\\Microsoft\\Windows\\CurrentVersion\\Internet Settings", "ProxyEnable", 0);
348 if (iProxyEnable > 0) {
349 string strHttpProxy = "";
350 bool bBypassOnLocal = false;
351 ArrayList al = new ArrayList ();
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);
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);
362 } else strHttpProxy = strProxyServer;
364 if (strProxyOverrride != null) {
365 string[] bypassList = strProxyOverrride.Split (new char[] { ';' }, StringSplitOptions.RemoveEmptyEntries);
367 foreach (string str in bypassList) {
368 if (str != "<local>")
371 bBypassOnLocal = true;
375 return new WebProxy (strHttpProxy, bBypassOnLocal, al.ToArray (typeof(string)) as string[]);
379 if (Platform.IsMacOS)
380 return CFNetwork.GetDefaultProxy ();
382 string address = Environment.GetEnvironmentVariable ("http_proxy");
385 address = Environment.GetEnvironmentVariable ("HTTP_PROXY");
387 if (address != null) {
389 if (!address.StartsWith ("http://"))
390 address = "http://" + address;
392 Uri uri = new Uri (address);
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";
400 } else if (IPAddress.IPv6Any.Equals (ip)) {
401 UriBuilder builder = new UriBuilder (uri);
402 builder.Host = "[::1]";
407 bool bBypassOnLocal = false;
408 ArrayList al = new ArrayList ();
409 string bypass = Environment.GetEnvironmentVariable ("no_proxy");
412 bypass = Environment.GetEnvironmentVariable ("NO_PROXY");
414 if (bypass != null) {
415 string[] bypassList = bypass.Split (new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
417 foreach (string str in bypassList) {
418 if (str != "*.local")
421 bBypassOnLocal = true;
425 return new WebProxy (uri, bBypassOnLocal, al.ToArray (typeof(string)) as string[]);
426 } catch (UriFormatException) {
433 return new WebProxy ();
437 void ISerializable.GetObjectData (SerializationInfo serializationInfo, StreamingContext streamingContext)
439 throw new NotSupportedException ();
442 protected virtual void GetObjectData (SerializationInfo serializationInfo, StreamingContext streamingContext)
444 throw GetMustImplement ();
447 public static bool RegisterPrefix (string prefix, IWebRequestCreate creator)
450 throw new ArgumentNullException ("prefix");
452 throw new ArgumentNullException ("creator");
454 lock (prefixes.SyncRoot) {
455 string lowerCasePrefix = prefix.ToLower (CultureInfo.InvariantCulture);
456 if (prefixes.Contains (lowerCasePrefix))
458 prefixes.Add (lowerCasePrefix, creator);
463 private static IWebRequestCreate GetCreator (string prefix)
465 int longestPrefix = -1;
466 IWebRequestCreate creator = null;
468 prefix = prefix.ToLower (CultureInfo.InvariantCulture);
470 IDictionaryEnumerator e = prefixes.GetEnumerator ();
471 while (e.MoveNext ()) {
472 string key = e.Key as string;
474 if (key.Length <= longestPrefix)
477 if (!prefix.StartsWith (key))
480 longestPrefix = key.Length;
481 creator = (IWebRequestCreate) e.Value;
485 throw new NotSupportedException (prefix);
490 internal static bool IsWindows ()
492 return (int) Environment.OSVersion.Platform < 4;
495 internal static void ClearPrefixes ()
500 internal static void RemovePrefix (string prefix)
502 prefixes.Remove (prefix);
505 internal static void AddPrefix (string prefix, string typeName)
507 Type type = Type.GetType (typeName);
509 throw new ConfigurationException (String.Format ("Type {0} not found", typeName));
510 AddPrefix (prefix, type);
513 internal static void AddPrefix (string prefix, Type type)
515 object o = Activator.CreateInstance (type, true);
516 prefixes [prefix] = o;
520 public virtual Task<Stream> GetRequestStreamAsync ()
522 return Task<Stream>.Factory.FromAsync (BeginGetRequestStream, EndGetRequestStream, null);
525 public virtual Task<WebResponse> GetResponseAsync ()
527 return Task<WebResponse>.Factory.FromAsync (BeginGetResponse, EndGetResponse, null);