Mirror
/
websocket-sharp
mirror of https://github.com/sta/websocket-sharp.git
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

Refactored HttpServer.cs

pull/75/head
sta 11 years ago
parent
1a1b109508
commit
e15cc63036
1 changed files with 129 additions and 160 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 289
      websocket-sharp/Server/HttpServer.cs

289
websocket-sharp/Server/HttpServer.cs
View File

@ -31,7 +31,7 @@
#region Contributors
/*
* Contributors:
* Juan Manuel Lallana <juan.manuel.lallana@gmail.com>
* - Juan Manuel Lallana <juan.manuel.lallana@gmail.com>
*/
#endregion
@ -79,7 +79,7 @@ namespace WebSocketSharp.Server
/// An instance initialized by this constructor listens for the incoming requests on port 80.
/// </remarks>
public HttpServer ()
: this (80)
: this (80, false)
{
}
@ -89,11 +89,11 @@ namespace WebSocketSharp.Server
/// </summary>
/// <remarks>
/// <para>
/// An instance initialized by this constructor listens for the incoming requests on
/// <paramref name="port"/>.
/// An instance initialized by this constructor listens for the incoming requests
/// on <paramref name="port"/>.
/// </para>
/// <para>
/// And if <paramref name="port"/> is 443, that instance provides a secure connection.
/// If <paramref name="port"/> is 443, that instance provides a secure connection.
/// </para>
/// </remarks>
/// <param name="port">
@ -112,30 +112,30 @@ namespace WebSocketSharp.Server
/// <paramref name="port"/> and <paramref name="secure"/>.
/// </summary>
/// <remarks>
/// An instance initialized by this constructor listens for the incoming requests on
/// <paramref name="port"/>.
/// An instance initialized by this constructor listens for the incoming requests
/// on <paramref name="port"/>.
/// </remarks>
/// <param name="port">
/// An <see cref="int"/> that represents the port number on which to listen.
/// </param>
/// <param name="secure">
/// A <see cref="bool"/> that indicates providing a secure connection or not. (<c>true</c>
/// indicates providing a secure connection.)
/// A <see cref="bool"/> that indicates providing a secure connection or not.
/// (<c>true</c> indicates providing a secure connection.)
/// </param>
/// <exception cref="ArgumentOutOfRangeException">
/// <paramref name="port"/> isn't between 1 and 65535.
/// </exception>
/// <exception cref="ArgumentException">
/// Pair of <paramref name="port"/> and <paramref name="secure"/> is invalid.
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
/// <paramref name="port"/> isn't between 1 and 65535.
/// </exception>
public HttpServer (int port, bool secure)
{
if (!port.IsPortNumber ())
throw new ArgumentOutOfRangeException ("port", "Must be between 1 and 65535: " + port);
throw new ArgumentOutOfRangeException ("port", "Not between 1 and 65535: " + port);
if ((port == 80 && secure) || (port == 443 && !secure))
throw new ArgumentException (
String.Format ("Invalid pair of 'port' and 'secure': {0}, {1}", port, secure));
String.Format ("An invalid pair of 'port' and 'secure': {0}, {1}", port, secure));
_port = port;
_secure = secure;
@ -146,8 +146,7 @@ namespace WebSocketSharp.Server
_sync = new object ();
var os = Environment.OSVersion;
if (os.Platform != PlatformID.Unix && os.Platform != PlatformID.MacOSX)
_windows = true;
_windows = os.Platform != PlatformID.Unix && os.Platform != PlatformID.MacOSX;
var prefix = String.Format ("http{0}://*:{1}/", _secure ? "s" : "", _port);
_listener.Prefixes.Add (prefix);
@ -161,9 +160,9 @@ namespace WebSocketSharp.Server
/// Gets or sets the scheme used to authenticate the clients.
/// </summary>
/// <value>
/// One of the <see cref="WebSocketSharp.Net.AuthenticationSchemes"/> enum values, indicates
/// the scheme used to authenticate the clients.
/// The default value is <see cref="WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>.
/// One of the <see cref="WebSocketSharp.Net.AuthenticationSchemes"/> enum values,
/// indicates the scheme used to authenticate the clients. The default value is
/// <see cref="WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>.
/// </value>
public AuthenticationSchemes AuthenticationSchemes {
get {
@ -171,8 +170,11 @@ namespace WebSocketSharp.Server
}
set {
if (!canSet ("AuthenticationSchemes"))
var msg = _state.CheckIfStartable ();
if (msg != null) {
_logger.Error (msg);
return;
}
_listener.AuthenticationSchemes = value;
}
@ -182,7 +184,8 @@ namespace WebSocketSharp.Server
/// Gets or sets the certificate used to authenticate the server on the secure connection.
/// </summary>
/// <value>
/// A <see cref="X509Certificate2"/> used to authenticate the server.
/// A <see cref="X509Certificate2"/> that represents the certificate used to authenticate
/// the server.
/// </value>
public X509Certificate2 Certificate {
get {
@ -190,8 +193,11 @@ namespace WebSocketSharp.Server
}
set {
if (!canSet ("Certificate"))
var msg = _state.CheckIfStartable ();
if (msg != null) {
_logger.Error (msg);
return;
}
if (EndPointListener.CertificateExists (_port, _listener.CertificateFolderPath))
_logger.Warn ("The server certificate associated with the port number already exists.");
@ -225,12 +231,12 @@ namespace WebSocketSharp.Server
}
/// <summary>
/// Gets or sets a value indicating whether the server cleans up the inactive sessions in the
/// WebSocket services periodically.
/// Gets or sets a value indicating whether the server cleans up the inactive sessions
/// in the WebSocket services periodically.
/// </summary>
/// <value>
/// <c>true</c> if the server cleans up the inactive sessions every 60 seconds; otherwise,
/// <c>false</c>. The default value is <c>true</c>.
/// <c>true</c> if the server cleans up the inactive sessions every 60 seconds;
/// otherwise, <c>false</c>. The default value is <c>true</c>.
/// </value>
public bool KeepClean {
get {
@ -275,8 +281,8 @@ namespace WebSocketSharp.Server
/// Gets or sets the name of the realm associated with the server.
/// </summary>
/// <value>
/// A <see cref="string"/> that represents the name of the realm. The default value is
/// <c>SECRET AREA</c>.
/// A <see cref="string"/> that represents the name of the realm.
/// The default value is <c>"SECRET AREA"</c>.
/// </value>
public string Realm {
get {
@ -284,8 +290,11 @@ namespace WebSocketSharp.Server
}
set {
if (!canSet ("Realm"))
var msg = _state.CheckIfStartable ();
if (msg != null) {
_logger.Error (msg);
return;
}
_listener.Realm = value;
}
@ -295,19 +304,22 @@ namespace WebSocketSharp.Server
/// Gets or sets the document root path of the server.
/// </summary>
/// <value>
/// A <see cref="string"/> that represents the document root path of the server. The default
/// value is <c>./Public</c>.
/// A <see cref="string"/> that represents the document root path of the server.
/// The default value is <c>"./Public"</c>.
/// </value>
public string RootPath {
get {
return _rootPath.IsNullOrEmpty ()
? (_rootPath = "./Public")
: _rootPath;
return _rootPath != null && _rootPath.Length > 0
? _rootPath
: (_rootPath = "./Public");
}
set {
if (!canSet ("RootPath"))
var msg = _state.CheckIfStartable ();
if (msg != null) {
_logger.Error (msg);
return;
}
_rootPath = value;
}
@ -328,8 +340,11 @@ namespace WebSocketSharp.Server
}
set {
if (!canSet ("UserCredentialsFinder"))
var msg = _state.CheckIfStartable ();
if (msg != null) {
_logger.Error (msg);
return;
}
_listener.UserCredentialsFinder = value;
}
@ -416,69 +431,64 @@ namespace WebSocketSharp.Server
_state = ServerState.Stop;
}
private void acceptHttpRequest (HttpListenerContext context)
private bool authenticateRequest (AuthenticationSchemes scheme, HttpListenerContext context)
{
if (context.Request.IsAuthenticated)
return true;
if (scheme == AuthenticationSchemes.Basic)
context.Response.CloseWithAuthChallenge (
AuthenticationChallenge.CreateBasicChallenge (_listener.Realm).ToBasicString ());
else if (scheme == AuthenticationSchemes.Digest)
context.Response.CloseWithAuthChallenge (
AuthenticationChallenge.CreateDigestChallenge (_listener.Realm).ToDigestString ());
else
context.Response.Close (HttpStatusCode.Forbidden);
return false;
}
private string checkIfCertificateExists ()
{
return _secure &&
!EndPointListener.CertificateExists (_port, _listener.CertificateFolderPath) &&
_listener.DefaultCertificate == null
? "The secure connection requires a server certificate."
: null;
}
private void processHttpRequest (HttpListenerContext context)
{
var args = new HttpRequestEventArgs (context);
var method = context.Request.HttpMethod;
if (method == "GET") {
if (OnGet != null) {
OnGet (this, args);
return;
}
}
else if (method == "HEAD") {
if (OnHead != null) {
OnHead (this, args);
return;
}
}
else if (method == "POST") {
if (OnPost != null) {
OnPost (this, args);
return;
}
}
else if (method == "PUT") {
if (OnPut != null) {
OnPut (this, args);
return;
}
}
else if (method == "DELETE") {
if (OnDelete != null) {
OnDelete (this, args);
return;
}
}
else if (method == "OPTIONS") {
if (OnOptions != null) {
OnOptions (this, args);
return;
}
}
else if (method == "TRACE") {
if (OnTrace != null) {
OnTrace (this, args);
return;
}
}
else if (method == "CONNECT") {
if (OnConnect != null) {
OnConnect (this, args);
return;
}
}
else if (method == "PATCH") {
if (OnPatch != null) {
OnPatch (this, args);
return;
}
var evt = method == "GET"
? OnGet
: method == "HEAD"
? OnHead
: method == "POST"
? OnPost
: method == "PUT"
? OnPut
: method == "DELETE"
? OnDelete
: method == "OPTIONS"
? OnOptions
: method == "TRACE"
? OnTrace
: method == "CONNECT"
? OnConnect
: method == "PATCH"
? OnPatch
: null;
if (evt != null) {
evt (this, new HttpRequestEventArgs (context));
return;
}
context.Response.StatusCode = (int) HttpStatusCode.NotImplemented;
}
private void acceptRequestAsync (HttpListenerContext context)
private void processRequestAsync (HttpListenerContext context)
{
ThreadPool.QueueUserWorkItem (
state => {
@ -489,11 +499,11 @@ namespace WebSocketSharp.Server
return;
if (context.Request.IsUpgradeTo ("websocket")) {
acceptWebSocketRequest (context.AcceptWebSocket (null, _logger));
processWebSocketRequest (context.AcceptWebSocket (null, _logger));
return;
}
acceptHttpRequest (context);
processHttpRequest (context);
context.Response.Close ();
}
catch (Exception ex) {
@ -503,7 +513,7 @@ namespace WebSocketSharp.Server
});
}
private void acceptWebSocketRequest (HttpListenerWebSocketContext context)
private void processWebSocketRequest (HttpListenerWebSocketContext context)
{
WebSocketServiceHost host;
if (!_services.TryGetServiceHostInternally (context.RequestUri.AbsolutePath, out host)) {
@ -514,51 +524,11 @@ namespace WebSocketSharp.Server
host.StartSession (context);
}
private bool authenticateRequest (AuthenticationSchemes scheme, HttpListenerContext context)
{
if (context.Request.IsAuthenticated)
return true;
if (scheme == AuthenticationSchemes.Basic)
context.Response.CloseWithAuthChallenge (
AuthenticationChallenge.CreateBasicChallenge (_listener.Realm).ToBasicString ());
else if (scheme == AuthenticationSchemes.Digest)
context.Response.CloseWithAuthChallenge (
AuthenticationChallenge.CreateDigestChallenge (_listener.Realm).ToDigestString ());
else
context.Response.Close (HttpStatusCode.Forbidden);
return false;
}
private bool canSet (string property)
{
if (_state == ServerState.Start || _state == ServerState.ShuttingDown) {
_logger.Error (
String.Format (
"Set operation of {0} isn't available because the server has already started.",
property));
return false;
}
return true;
}
private string checkIfCertExists ()
{
return _secure &&
!EndPointListener.CertificateExists (_port, _listener.CertificateFolderPath) &&
Certificate == null
? "The secure connection requires a server certificate."
: null;
}
private void receiveRequest ()
{
while (true) {
try {
acceptRequestAsync (_listener.GetContext ());
processRequestAsync (_listener.GetContext ());
}
catch (HttpListenerException ex) {
_logger.Warn ("Receiving has been stopped.\nreason: " + ex.Message);
@ -602,9 +572,8 @@ namespace WebSocketSharp.Server
/// A <see cref="string"/> that represents the absolute path to the WebSocket service to add.
/// </param>
/// <typeparam name="TWithNew">
/// The type of the WebSocket service.
/// The TWithNew must inherit the <see cref="WebSocketService"/> class and must have a public
/// parameterless constructor.
/// The type of the WebSocket service. The TWithNew must inherit
/// the <see cref="WebSocketService"/> class and must have a public parameterless constructor.
/// </typeparam>
public void AddWebSocketService<TWithNew> (string path)
where TWithNew : WebSocketService, new ()
@ -614,22 +583,22 @@ namespace WebSocketSharp.Server
/// <summary>
/// Adds the specified typed WebSocket service with the specified <paramref name="path"/> and
/// <paramref name="constructor"/>.
/// <paramref name="initializer"/>.
/// </summary>
/// <remarks>
/// <para>
/// This method converts <paramref name="path"/> to URL-decoded string and removes <c>'/'</c>
/// from tail end of <paramref name="path"/>.
/// This method converts <paramref name="path"/> to URL-decoded string and
/// removes <c>'/'</c> from tail end of <paramref name="path"/>.
/// </para>
/// <para>
/// <paramref name="constructor"/> returns a initialized specified typed
/// <paramref name="initializer"/> returns an initialized specified typed
/// <see cref="WebSocketService"/> instance.
/// </para>
/// </remarks>
/// <param name="path">
/// A <see cref="string"/> that represents the absolute path to the WebSocket service to add.
/// </param>
/// <param name="constructor">
/// <param name="initializer">
/// A Func&lt;T&gt; delegate that references the method used to initialize a new specified
/// typed <see cref="WebSocketService"/> instance (a new <see cref="IWebSocketSession"/>
/// instance).
@ -638,18 +607,18 @@ namespace WebSocketSharp.Server
/// The type of the WebSocket service. The T must inherit the <see cref="WebSocketService"/>
/// class.
/// </typeparam>
public void AddWebSocketService<T> (string path, Func<T> constructor)
public void AddWebSocketService<T> (string path, Func<T> initializer)
where T : WebSocketService
{
var msg = path.CheckIfValidServicePath () ??
(constructor == null ? "'constructor' must not be null." : null);
(initializer == null ? "'initializer' is null." : null);
if (msg != null) {
_logger.Error (String.Format ("{0}\nservice path: {1}", msg, path));
return;
}
var host = new WebSocketServiceHost<T> (path, constructor, _logger);
var host = new WebSocketServiceHost<T> (path, initializer, _logger);
if (!KeepClean)
host.KeepClean = false;
@ -660,13 +629,13 @@ namespace WebSocketSharp.Server
/// Gets the contents of the file with the specified <paramref name="path"/>.
/// </summary>
/// <returns>
/// An array of <see cref="byte"/> that receives the contents of the file if it exists;
/// otherwise, <see langword="null"/>.
/// An array of <see cref="byte"/> that receives the contents of the file,
/// or <see langword="null"/> if it doesn't exist.
/// </returns>
/// <param name="path">
/// A <see cref="string"/> that represents the virtual path to the file to find.
/// </param>
public byte [] GetFile (string path)
public byte[] GetFile (string path)
{
var filePath = RootPath + path;
if (_windows)
@ -681,12 +650,12 @@ namespace WebSocketSharp.Server
/// Removes the WebSocket service with the specified <paramref name="path"/>.
/// </summary>
/// <remarks>
/// This method converts <paramref name="path"/> to URL-decoded string and removes <c>'/'</c>
/// from tail end of <paramref name="path"/>.
/// This method converts <paramref name="path"/> to URL-decoded string and
/// removes <c>'/'</c> from tail end of <paramref name="path"/>.
/// </remarks>
/// <returns>
/// <c>true</c> if the WebSocket service is successfully found and removed; otherwise,
/// <c>false</c>.
/// <c>true</c> if the WebSocket service is successfully found and removed;
/// otherwise, <c>false</c>.
/// </returns>
/// <param name="path">
/// A <see cref="string"/> that represents the absolute path to the WebSocket service to find.
@ -708,7 +677,7 @@ namespace WebSocketSharp.Server
public void Start ()
{
lock (_sync) {
var msg = _state.CheckIfStartable () ?? checkIfCertExists ();
var msg = _state.CheckIfStartable () ?? checkIfCertificateExists ();
if (msg != null) {
_logger.Error (String.Format ("{0}\nstate: {1}\nsecure: {2}", msg, _state, _secure));
return;
@ -737,7 +706,7 @@ namespace WebSocketSharp.Server
_state = ServerState.ShuttingDown;
}
_services.Stop (new byte [0], true);
_services.Stop (new byte[0], true);
stopListener (5000);
_state = ServerState.Stop;
@ -755,7 +724,7 @@ namespace WebSocketSharp.Server
/// </param>
public void Stop (ushort code, string reason)
{
byte [] data = null;
byte[] data = null;
lock (_sync) {
var msg = _state.CheckIfStart () ??
code.CheckIfValidCloseStatusCode () ??
@ -782,15 +751,15 @@ namespace WebSocketSharp.Server
/// <see cref="string"/> used to stop the WebSocket services.
/// </summary>
/// <param name="code">
/// One of the <see cref="CloseStatusCode"/> enum values, represents the status code indicating
/// the reasons for stop.
/// One of the <see cref="CloseStatusCode"/> enum values, represents the status code
/// indicating the reasons for stop.
/// </param>
/// <param name="reason">
/// A <see cref="string"/> that represents the reason for stop.
/// </param>
public void Stop (CloseStatusCode code, string reason)
{
byte [] data = null;
byte[] data = null;
lock (_sync) {
var msg = _state.CheckIfStart () ??
(data = ((ushort) code).Append (reason)).CheckIfValidControlData ("reason");

Write Preview
Loading…
Cancel
Save