2 // System.Net.HttpListener
5 // Gonzalo Paniagua Javier (gonzalo@novell.com)
7 // Copyright (c) 2005 Novell, Inc. (http://www.novell.com)
9 // Permission is hereby granted, free of charge, to any person obtaining
10 // a copy of this software and associated documentation files (the
11 // "Software"), to deal in the Software without restriction, including
12 // without limitation the rights to use, copy, modify, merge, publish,
13 // distribute, sublicense, and/or sell copies of the Software, and to
14 // permit persons to whom the Software is furnished to do so, subject to
15 // the following conditions:
17 // The above copyright notice and this permission notice shall be
18 // included in all copies or substantial portions of the Software.
20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 #if NET_2_0 && SECURITY_DEP
31 using System.Collections;
32 using System.Threading;
34 namespace System.Net {
35 public sealed class HttpListener : IDisposable {
36 AuthenticationSchemes auth_schemes;
37 HttpListenerPrefixCollection prefixes;
38 AuthenticationSchemeSelector auth_selector;
40 bool ignore_write_exceptions;
41 bool unsafe_ntlm_auth;
45 Hashtable registry; // Dictionary<HttpListenerContext,HttpListenerContext>
46 ArrayList ctx_queue; // List<HttpListenerContext> ctx_queue;
47 ArrayList wait_queue; // List<ListenerAsyncResult> wait_queue;
48 Hashtable connections;
50 public HttpListener ()
52 prefixes = new HttpListenerPrefixCollection (this);
53 registry = new Hashtable ();
54 connections = Hashtable.Synchronized (new Hashtable ());
55 ctx_queue = new ArrayList ();
56 wait_queue = new ArrayList ();
57 auth_schemes = AuthenticationSchemes.Anonymous;
60 // TODO: Digest, NTLM and Negotiate require ControlPrincipal
61 public AuthenticationSchemes AuthenticationSchemes {
62 get { return auth_schemes; }
69 public AuthenticationSchemeSelector AuthenticationSchemeSelectorDelegate {
70 get { return auth_selector; }
73 auth_selector = value;
77 public bool IgnoreWriteExceptions {
78 get { return ignore_write_exceptions; }
81 ignore_write_exceptions = value;
85 public bool IsListening {
86 get { return listening; }
89 public static bool IsSupported {
93 public HttpListenerPrefixCollection Prefixes {
101 public string Realm {
102 get { return realm; }
109 [MonoTODO ("Support for NTLM needs some loving.")]
110 public bool UnsafeConnectionNtlmAuthentication {
111 get { return unsafe_ntlm_auth; }
114 unsafe_ntlm_auth = value;
144 void Close (bool force)
147 EndPointManager.RemoveListener (this);
151 void Cleanup (bool close_existing)
154 if (close_existing) {
155 foreach (HttpListenerContext context in registry.Keys) {
156 context.Connection.Close ();
162 foreach (HttpConnection cnc in connections.Keys) {
165 connections.Clear ();
168 foreach (HttpListenerContext context in ctx_queue)
169 context.Connection.Close (true);
175 foreach (ListenerAsyncResult ares in wait_queue) {
176 ares.Complete ("Listener was closed.");
183 public IAsyncResult BeginGetContext (AsyncCallback callback, Object state)
187 throw new InvalidOperationException ("Please, call Start before using this method.");
189 ListenerAsyncResult ares = new ListenerAsyncResult (callback, state);
191 // lock wait_queue early to avoid race conditions
194 HttpListenerContext ctx = GetContextFromQueue ();
196 ares.Complete (ctx, true);
201 wait_queue.Add (ares);
207 public HttpListenerContext EndGetContext (IAsyncResult asyncResult)
210 if (asyncResult == null)
211 throw new ArgumentNullException ("asyncResult");
213 ListenerAsyncResult ares = asyncResult as ListenerAsyncResult;
215 throw new ArgumentException ("Wrong IAsyncResult.", "asyncResult");
217 if (!ares.IsCompleted)
218 ares.AsyncWaitHandle.WaitOne ();
221 int idx = wait_queue.IndexOf (ares);
223 wait_queue.RemoveAt (idx);
226 HttpListenerContext context = ares.GetContext ();
227 context.ParseAuthentication (SelectAuthenticationScheme (context));
228 return context; // This will throw on error.
231 internal AuthenticationSchemes SelectAuthenticationScheme (HttpListenerContext context)
233 if (AuthenticationSchemeSelectorDelegate != null)
234 return AuthenticationSchemeSelectorDelegate (context.Request);
239 public HttpListenerContext GetContext ()
241 // The prefixes are not checked when using the async interface!?
242 if (prefixes.Count == 0)
243 throw new InvalidOperationException ("Please, call AddPrefix before using this method.");
245 IAsyncResult ares = BeginGetContext (null, null);
246 return EndGetContext (ares);
255 EndPointManager.AddListener (this);
266 void IDisposable.Dispose ()
271 Close (true); //TODO: Should we force here or not?
275 internal void CheckDisposed ()
278 throw new ObjectDisposedException (GetType ().ToString ());
281 // Must be called with a lock on ctx_queue
282 HttpListenerContext GetContextFromQueue ()
284 if (ctx_queue.Count == 0)
287 HttpListenerContext context = (HttpListenerContext) ctx_queue [0];
288 ctx_queue.RemoveAt (0);
292 internal void RegisterContext (HttpListenerContext context)
295 registry [context] = context;
297 ListenerAsyncResult ares = null;
299 if (wait_queue.Count == 0) {
301 ctx_queue.Add (context);
303 ares = (ListenerAsyncResult) wait_queue [0];
304 wait_queue.RemoveAt (0);
308 ares.Complete (context);
311 internal void UnregisterContext (HttpListenerContext context)
314 registry.Remove (context);
316 int idx = ctx_queue.IndexOf (context);
318 ctx_queue.RemoveAt (idx);
322 internal void AddConnection (HttpConnection cnc)
324 connections [cnc] = cnc;
327 internal void RemoveConnection (HttpConnection cnc)
329 connections.Remove (cnc);