#region License
/*
* HttpServer.cs
*
* The MIT License
*
* Copyright (c) 2012-2013 sta.blockhead
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#endregion
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Threading;
using WebSocketSharp.Net;
namespace WebSocketSharp.Server
{
///
/// Provides a simple HTTP server that allows to accept the WebSocket connection requests.
///
///
/// The HttpServer instance can provide the multi WebSocket services.
///
public class HttpServer
{
#region Private Fields
private HttpListener _listener;
private bool _listening;
private Logger _logger;
private int _port;
private Thread _receiveRequestThread;
private string _rootPath;
private ServiceHostManager _svcHosts;
private bool _windows;
#endregion
#region Public Constructors
///
/// Initializes a new instance of the class that listens for incoming requests
/// on port 80.
///
public HttpServer ()
: this (80)
{
}
///
/// Initializes a new instance of the class that listens for incoming requests
/// on the specified .
///
///
/// An that contains a port number.
///
public HttpServer (int port)
{
_port = port;
init ();
}
#endregion
#region Public Properties
///
/// Gets a value indicating whether the server has been started.
///
///
/// true if the server has been started; otherwise, false.
///
public bool IsListening {
get {
return _listening;
}
}
///
/// Gets or sets a value indicating whether the server cleans up the inactive WebSocket service
/// instances periodically.
///
///
/// true if the server cleans up the inactive WebSocket service instances every 60 seconds;
/// otherwise, false. The default value is true.
///
public bool KeepClean {
get {
return _svcHosts.KeepClean;
}
set {
_svcHosts.KeepClean = value;
}
}
///
/// Gets the logging functions.
///
///
/// The default logging level is the .
/// If you want to change the current logging level, you set the Log.Level property
/// to one of the values which you want.
///
///
/// A that provides the logging functions.
///
public Logger Log {
get {
return _logger;
}
}
///
/// Gets the port on which to listen for incoming requests.
///
///
/// An that contains a port number.
///
public int Port {
get {
return _port;
}
}
///
/// Gets or sets the document root path of server.
///
///
/// A that contains the document root path of server.
/// The default value is ./Public.
///
public string RootPath {
get {
return _rootPath;
}
set {
if (!_listening)
_rootPath = value;
}
}
///
/// Gets the collection of paths associated with the every WebSocket services that the server provides.
///
///
/// An IEnumerable<string> that contains the collection of paths.
///
public IEnumerable ServicePaths {
get {
return _svcHosts.Paths;
}
}
#endregion
#region Public Events
///
/// Occurs when the server receives an HTTP CONNECT request.
///
public event EventHandler OnConnect;
///
/// Occurs when the server receives an HTTP DELETE request.
///
public event EventHandler OnDelete;
///
/// Occurs when the server gets an error.
///
public event EventHandler OnError;
///
/// Occurs when the server receives an HTTP GET request.
///
public event EventHandler OnGet;
///
/// Occurs when the server receives an HTTP HEAD request.
///
public event EventHandler OnHead;
///
/// Occurs when the server receives an HTTP OPTIONS request.
///
public event EventHandler OnOptions;
///
/// Occurs when the server receives an HTTP PATCH request.
///
public event EventHandler OnPatch;
///
/// Occurs when the server receives an HTTP POST request.
///
public event EventHandler OnPost;
///
/// Occurs when the server receives an HTTP PUT request.
///
public event EventHandler OnPut;
///
/// Occurs when the server receives an HTTP TRACE request.
///
public event EventHandler OnTrace;
#endregion
#region Private Methods
private void error (string message)
{
OnError.Emit (this, new ErrorEventArgs (message));
}
private void init ()
{
_listener = new HttpListener ();
_listening = false;
_logger = new Logger ();
_rootPath = "./Public";
_svcHosts = new ServiceHostManager ();
_windows = false;
var os = Environment.OSVersion;
if (os.Platform != PlatformID.Unix && os.Platform != PlatformID.MacOSX)
_windows = true;
var prefix = String.Format ("http{0}://*:{1}/", _port == 443 ? "s" : "", _port);
_listener.Prefixes.Add (prefix);
}
private void processHttpRequest (HttpListenerContext context)
{
var eventArgs = new HttpRequestEventArgs (context);
var method = context.Request.HttpMethod;
if (method == "GET" && OnGet != null)
{
OnGet (this, eventArgs);
return;
}
if (method == "HEAD" && OnHead != null)
{
OnHead (this, eventArgs);
return;
}
if (method == "POST" && OnPost != null)
{
OnPost (this, eventArgs);
return;
}
if (method == "PUT" && OnPut != null)
{
OnPut (this, eventArgs);
return;
}
if (method == "DELETE" && OnDelete != null)
{
OnDelete (this, eventArgs);
return;
}
if (method == "OPTIONS" && OnOptions != null)
{
OnOptions (this, eventArgs);
return;
}
if (method == "TRACE" && OnTrace != null)
{
OnTrace (this, eventArgs);
return;
}
if (method == "CONNECT" && OnConnect != null)
{
OnConnect (this, eventArgs);
return;
}
if (method == "PATCH" && OnPatch != null)
{
OnPatch (this, eventArgs);
return;
}
context.Response.StatusCode = (int) HttpStatusCode.NotImplemented;
}
private bool processWebSocketRequest (HttpListenerContext context)
{
var wsContext = context.AcceptWebSocket ();
var path = wsContext.Path.UrlDecode ();
IServiceHost svcHost;
if (!_svcHosts.TryGetServiceHost (path, out svcHost))
{
context.Response.StatusCode = (int) HttpStatusCode.NotImplemented;
return false;
}
wsContext.WebSocket.Log = _logger;
svcHost.BindWebSocket (wsContext);
return true;
}
private void processRequestAsync (HttpListenerContext context)
{
WaitCallback callback = state =>
{
try {
if (context.Request.IsUpgradeTo ("websocket"))
{
if (processWebSocketRequest (context))
return;
}
else
{
processHttpRequest (context);
}
context.Response.Close ();
}
catch (Exception ex) {
_logger.Fatal (ex.Message);
error ("An exception has occured.");
}
};
ThreadPool.QueueUserWorkItem (callback);
}
private void receiveRequest ()
{
while (true)
{
try {
processRequestAsync (_listener.GetContext ());
}
catch (HttpListenerException) {
_logger.Info ("HttpListener has been stopped.");
break;
}
catch (Exception ex) {
_logger.Fatal (ex.Message);
error ("An exception has occured.");
break;
}
}
}
private void startReceiveRequestThread ()
{
_receiveRequestThread = new Thread (new ThreadStart (receiveRequest));
_receiveRequestThread.IsBackground = true;
_receiveRequestThread.Start ();
}
#endregion
#region Public Methods
///
/// Adds the specified typed WebSocket service.
///
///
/// A that contains an absolute path associated with the WebSocket service.
///
///
/// The type of the WebSocket service. The T must inherit the class.
///
public void AddWebSocketService (string absPath)
where T : WebSocketService, new ()
{
string msg;
if (!absPath.IsValidAbsolutePath (out msg))
{
_logger.Error (msg);
error (msg);
return;
}
var svcHost = new WebSocketServiceHost (_logger);
svcHost.Uri = absPath.ToUri ();
if (!KeepClean)
svcHost.KeepClean = false;
_svcHosts.Add (absPath, svcHost);
}
///
/// Gets the contents of the file with the specified .
///
///
/// An array of that contains the contents of the file if exists;
/// otherwise, .
///
///
/// A that contains a virtual path to the file to get.
///
public byte[] GetFile (string path)
{
var filePath = _rootPath + path;
if (_windows)
filePath = filePath.Replace ("/", "\\");
return File.Exists (filePath)
? File.ReadAllBytes (filePath)
: null;
}
///
/// Starts to receive the HTTP requests.
///
public void Start ()
{
if (_listening)
return;
_listener.Start ();
startReceiveRequestThread ();
_listening = true;
}
///
/// Stops receiving the HTTP requests.
///
public void Stop ()
{
if (!_listening)
return;
_listener.Close ();
_receiveRequestThread.Join (5 * 1000);
_svcHosts.Stop ();
_listening = false;
}
#endregion
}
}