capricorn 2.0.8 → 2.0.9

data/erlang/lib/misultin/src/misultin_utility.erl

@@ -0,0 +1,357 @@
+% ==========================================================================================================
+% MISULTIN - Various Utilities
+%
+% >-|-|-(°>
+% 
+% Copyright (C) 2010, Roberto Ostinelli <roberto@ostinelli.net>.
+% All rights reserved.
+%
+% BSD License
+% 
+% Redistribution and use in source and binary forms, with or without modification, are permitted provided
+% that the following conditions are met:
+%
+%  * Redistributions of source code must retain the above copyright notice, this list of conditions and the
+%	 following disclaimer.
+%  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
+%	 the following disclaimer in the documentation and/or other materials provided with the distribution.
+%  * Neither the name of the authors nor the names of its contributors may be used to endorse or promote
+%	 products derived from this software without specific prior written permission.
+%
+% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
+% WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+% PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+% ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+% TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+% HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+% NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+% POSSIBILITY OF SUCH DAMAGE.
+% ==========================================================================================================
+-module(misultin_utility).
+-vsn("0.6.1").
+
+% API
+-export([get_http_status_code/1, get_content_type/1, get_key_value/2, header_get_value/2]).
+
+
+% ============================ \/ API ======================================================================
+
+% Function: HttpStatus
+% Description: Returns a complete HTTP header
+% most common first
+get_http_status_code(200) ->
+	"HTTP/1.1 200 OK\r\n";
+get_http_status_code(100) ->
+	"HTTP/1.1 100 Continue\r\n";
+get_http_status_code(101) ->
+	"HTTP/1.1 101 Switching Protocols\r\n";
+get_http_status_code(301) ->
+	"HTTP/1.1 301 Moved Permanently\r\n";
+get_http_status_code(400) ->
+	"HTTP/1.1 400 Bad Request\r\n";
+get_http_status_code(401) ->
+	"HTTP/1.1 401 Unauthorized\r\n";	
+get_http_status_code(403) ->
+	"HTTP/1.1 403 Forbidden\r\n";
+get_http_status_code(404) ->
+	"HTTP/1.1 404 Not Found\r\n";				
+get_http_status_code(408) ->
+	"HTTP/1.1 408 Request Timeout\r\n";			
+get_http_status_code(500) ->
+	"HTTP/1.1 500 Internal Server Error\r\n";
+get_http_status_code(501) ->
+	"HTTP/1.1 501 Not Implemented\r\n";				
+% less common last
+get_http_status_code(201) ->
+	"HTTP/1.1 201 Created\r\n";
+get_http_status_code(202) ->
+	"HTTP/1.1 202 Accepted\r\n";
+get_http_status_code(203) ->
+	"HTTP/1.1 203 Non-Authoritative Information\r\n";
+get_http_status_code(204) ->
+	"HTTP/1.1 204 No Content\r\n";
+get_http_status_code(205) ->
+	"HTTP/1.1 205 Reset Content\r\n";
+get_http_status_code(206) ->
+	"HTTP/1.1 206 Partial Content\r\n";
+get_http_status_code(300) ->
+	"HTTP/1.1 300 Multiple Choices\r\n";
+get_http_status_code(302) ->
+	"HTTP/1.1 302 Found\r\n";
+get_http_status_code(303) ->
+	"HTTP/1.1 303 See Other\r\n";
+get_http_status_code(304) ->
+	"HTTP/1.1 304 Not Modified\r\n";
+get_http_status_code(305) ->
+	"HTTP/1.1 305 Use Proxy\r\n";
+get_http_status_code(307) ->
+	"HTTP/1.1 307 Temporary Redirect\r\n";
+get_http_status_code(402) ->
+	"HTTP/1.1 402 Payment Required\r\n";
+get_http_status_code(405) ->
+	"HTTP/1.1 405 Method Not Allowed\r\n";
+get_http_status_code(406) ->
+	"HTTP/1.1 406 Not Acceptable\r\n";
+get_http_status_code(407) ->
+	"HTTP/1.1 407 Proxy Authentication Required\r\n";
+get_http_status_code(409) ->
+	"HTTP/1.1 409 Conflict\r\n";
+get_http_status_code(410) ->
+	"HTTP/1.1 410 Gone\r\n";
+get_http_status_code(411) ->
+	"HTTP/1.1 411 Length Required\r\n";
+get_http_status_code(412) ->
+	"HTTP/1.1 412 Precondition Failed\r\n";
+get_http_status_code(413) ->
+	"HTTP/1.1 413 Request Entity Too Large\r\n";
+get_http_status_code(414) ->
+	"HTTP/1.1 414 Request-URI Too Long\r\n";
+get_http_status_code(415) ->
+	"HTTP/1.1 415 Unsupported Media Type\r\n";
+get_http_status_code(416) ->
+	"HTTP/1.1 416 Requested Range Not Satisfiable\r\n";
+get_http_status_code(417) ->
+	"HTTP/1.1 417 Expectation Failed\r\n";
+get_http_status_code(502) ->
+	"HTTP/1.1 502 Bad Gateway\r\n";
+get_http_status_code(503) ->
+	"HTTP/1.1 503 Service Unavailable\r\n";
+get_http_status_code(504) ->
+	"HTTP/1.1 504 Gateway Timeout\r\n";
+get_http_status_code(505) ->
+	"HTTP/1.1 505 HTTP Version Not Supported\r\n";
+get_http_status_code(Other) ->
+	lists:flatten(io_lib:format("HTTP/1.1 ~p \r\n", [Other])).
+
+% get content type
+get_content_type(FileName) ->
+	case filename:extension(FileName) of
+		% most common first
+		".doc" -> "application/msword";
+		".exe" -> "application/octet-stream";
+		".pdf" -> "application/pdf";
+		".rtf" -> "application/rtf";
+		".ppt" -> "application/vnd.ms-powerpoint";
+		".tgz" -> "application/x-compressed";
+		".tar" -> "application/x-tar";
+		".zip" -> "application/zip";
+		".mp3" -> "audio/mpeg";
+		".wav" -> "audio/x-wav";
+		".bmp" -> "image/bmp";
+		".ram" -> "audio/x-pn-realaudio";
+		".gif" -> "image/gif";
+		".jpe" -> "image/jpeg";
+		".jpeg" -> "image/jpeg";
+		".jpg" -> "image/jpeg";
+		".tif" -> "image/tiff";
+		".tiff" -> "image/tiff";
+		".htm" -> "text/html";
+		".html" -> "text/html";
+		".txt" -> "text/plain";
+		".mp2" -> "video/mpeg";
+		".mpa" -> "video/mpeg";
+		".mpe" -> "video/mpeg";
+		".mpeg" -> "video/mpeg";
+		".mpg" -> "video/mpeg";
+		".mov" -> "video/quicktime";
+		".avi" -> "video/x-msvideo";	
+		% less common last
+		".evy" -> "application/envoy";
+		".fif" -> "application/fractals";
+		".spl" -> "application/futuresplash";
+		".hta" -> "application/hta";
+		".acx" -> "application/internet-property-stream";
+		".hqx" -> "application/mac-binhex40";
+		".dot" -> "application/msword";
+		".bin" -> "application/octet-stream";
+		".class" -> "application/octet-stream";
+		".dms" -> "application/octet-stream";
+		".lha" -> "application/octet-stream";
+		".lzh" -> "application/octet-stream";
+		".oda" -> "application/oda";
+		".axs" -> "application/olescript";
+		".prf" -> "application/pics-rules";
+		".p10" -> "application/pkcs10";
+		".crl" -> "application/pkix-crl";
+		".ai" -> "application/postscript";
+		".eps" -> "application/postscript";
+		".ps" -> "application/postscript";
+		".setpay" -> "application/set-payment-initiation";
+		".setreg" -> "application/set-registration-initiation";
+		".xla" -> "application/vnd.ms-excel";
+		".xlc" -> "application/vnd.ms-excel";
+		".xlm" -> "application/vnd.ms-excel";
+		".xls" -> "application/vnd.ms-excel";
+		".xlt" -> "application/vnd.ms-excel";
+		".xlw" -> "application/vnd.ms-excel";
+		".msg" -> "application/vnd.ms-outlook";
+		".sst" -> "application/vnd.ms-pkicertstore";
+		".cat" -> "application/vnd.ms-pkiseccat";
+		".stl" -> "application/vnd.ms-pkistl";
+		".pot" -> "application/vnd.ms-powerpoint";
+		".pps" -> "application/vnd.ms-powerpoint";
+		".mpp" -> "application/vnd.ms-project";
+		".wcm" -> "application/vnd.ms-works";
+		".wdb" -> "application/vnd.ms-works";
+		".wks" -> "application/vnd.ms-works";
+		".wps" -> "application/vnd.ms-works";
+		".hlp" -> "application/winhlp";
+		".bcpio" -> "application/x-bcpio";
+		".cdf" -> "application/x-cdf";
+		".z" -> "application/x-compress";
+		".cpio" -> "application/x-cpio";
+		".csh" -> "application/x-csh";
+		".dcr" -> "application/x-director";
+		".dir" -> "application/x-director";
+		".dxr" -> "application/x-director";
+		".dvi" -> "application/x-dvi";
+		".gtar" -> "application/x-gtar";
+		".gz" -> "application/x-gzip";
+		".hdf" -> "application/x-hdf";
+		".ins" -> "application/x-internet-signup";
+		".isp" -> "application/x-internet-signup";
+		".iii" -> "application/x-iphone";
+		".js" -> "application/x-javascript";
+		".latex" -> "application/x-latex";
+		".mdb" -> "application/x-msaccess";
+		".crd" -> "application/x-mscardfile";
+		".clp" -> "application/x-msclip";
+		".dll" -> "application/x-msdownload";
+		".m13" -> "application/x-msmediaview";
+		".m14" -> "application/x-msmediaview";
+		".mvb" -> "application/x-msmediaview";
+		".wmf" -> "application/x-msmetafile";
+		".mny" -> "application/x-msmoney";
+		".pub" -> "application/x-mspublisher";
+		".scd" -> "application/x-msschedule";
+		".trm" -> "application/x-msterminal";
+		".wri" -> "application/x-mswrite";
+		".nc" -> "application/x-netcdf";
+		".pma" -> "application/x-perfmon";
+		".pmc" -> "application/x-perfmon";
+		".pml" -> "application/x-perfmon";
+		".pmr" -> "application/x-perfmon";
+		".pmw" -> "application/x-perfmon";
+		".p12" -> "application/x-pkcs12";
+		".pfx" -> "application/x-pkcs12";
+		".p7b" -> "application/x-pkcs7-certificates";
+		".spc" -> "application/x-pkcs7-certificates";
+		".p7r" -> "application/x-pkcs7-certreqresp";
+		".p7c" -> "application/x-pkcs7-mime";
+		".p7m" -> "application/x-pkcs7-mime";
+		".p7s" -> "application/x-pkcs7-signature";
+		".sh" -> "application/x-sh";
+		".shar" -> "application/x-shar";
+		".swf" -> "application/x-shockwave-flash";
+		".sit" -> "application/x-stuffit";
+		".sv4cpio" -> "application/x-sv4cpio";
+		".sv4crc" -> "application/x-sv4crc";
+		".tcl" -> "application/x-tcl";
+		".tex" -> "application/x-tex";
+		".texi" -> "application/x-texinfo";
+		".texinfo" -> "application/x-texinfo";
+		".roff" -> "application/x-troff";
+		".t" -> "application/x-troff";
+		".tr" -> "application/x-troff";
+		".man" -> "application/x-troff-man";
+		".me" -> "application/x-troff-me";
+		".ms" -> "application/x-troff-ms";
+		".ustar" -> "application/x-ustar";
+		".src" -> "application/x-wais-source";
+		".cer" -> "application/x-x509-ca-cert";
+		".crt" -> "application/x-x509-ca-cert";
+		".der" -> "application/x-x509-ca-cert";
+		".pko" -> "application/ynd.ms-pkipko";
+		".au" -> "audio/basic";
+		".snd" -> "audio/basic";
+		".mid" -> "audio/mid";
+		".rmi" -> "audio/mid";
+		".aif" -> "audio/x-aiff";
+		".aifc" -> "audio/x-aiff";
+		".aiff" -> "audio/x-aiff";
+		".m3u" -> "audio/x-mpegurl";
+		".ra" -> "audio/x-pn-realaudio";
+		".cod" -> "image/cis-cod";
+		".ief" -> "image/ief";
+		".jfif" -> "image/pipeg";
+		".svg" -> "image/svg+xml";
+		".ras" -> "image/x-cmu-raster";
+		".cmx" -> "image/x-cmx";
+		".ico" -> "image/x-icon";
+		".pnm" -> "image/x-portable-anymap";
+		".pbm" -> "image/x-portable-bitmap";
+		".pgm" -> "image/x-portable-graymap";
+		".ppm" -> "image/x-portable-pixmap";
+		".rgb" -> "image/x-rgb";
+		".xbm" -> "image/x-xbitmap";
+		".xpm" -> "image/x-xpixmap";
+		".xwd" -> "image/x-xwindowdump";
+		".mht" -> "message/rfc822";
+		".mhtml" -> "message/rfc822";
+		".nws" -> "message/rfc822";
+		".css" -> "text/css";
+		".323" -> "text/h323";
+		".stm" -> "text/html";
+		".uls" -> "text/iuls";
+		".bas" -> "text/plain";
+		".c" -> "text/plain";
+		".h" -> "text/plain";
+		".rtx" -> "text/richtext";
+		".sct" -> "text/scriptlet";
+		".tsv" -> "text/tab-separated-values";
+		".htt" -> "text/webviewhtml";
+		".htc" -> "text/x-component";
+		".etx" -> "text/x-setext";
+		".vcf" -> "text/x-vcard";
+		".mpv2" -> "video/mpeg";
+		".qt" -> "video/quicktime";
+		".lsf" -> "video/x-la-asf";
+		".lsx" -> "video/x-la-asf";
+		".asf" -> "video/x-ms-asf";
+		".asr" -> "video/x-ms-asf";
+		".asx" -> "video/x-ms-asf";
+		".movie" -> "video/x-sgi-movie";
+		".flr" -> "x-world/x-vrml";
+		".vrml" -> "x-world/x-vrml";
+		".wrl" -> "x-world/x-vrml";
+		".wrz" -> "x-world/x-vrml";
+		".xaf" -> "x-world/x-vrml";
+		".xof" -> "x-world/x-vrml";
+		_ -> "application/octet-stream"
+	end.
+
+% faster than proplists:get_value
+get_key_value(Key, List)->
+	case lists:keyfind(Key, 1, List) of
+		false-> undefined;
+		{_K, Value}-> Value
+	end.
+
+% Function: Value | false
+% Description: Find atom Tag in Headers, Headers being both atoms [for known headers] and strings. Comparison on string Header Tags is case insensitive.
+header_get_value(Tag, Headers) when is_atom(Tag) ->
+	case lists:keyfind(Tag, 1, Headers) of
+		false ->
+			% header not found, test also conversion to string -> convert all string tags to lowercase (HTTP tags are case insensitive)
+			F =  fun({HTag, HValue}) -> 
+				case is_atom(HTag) of
+					true -> {HTag, HValue};
+					false -> {string:to_lower(HTag), HValue}
+				end
+			end,
+			HeadersStr = lists:map(F, Headers),
+			% test
+			case lists:keyfind(string:to_lower(atom_to_list(Tag)), 1, HeadersStr) of
+				false -> false;
+				{_, Value} -> Value
+			end;
+		{_, Value} -> Value
+	end.
+
+% ============================ /\ API ======================================================================
+
+
+
+% ============================ \/ INTERNAL FUNCTIONS =======================================================
+
+% ============================ /\ INTERNAL FUNCTIONS =======================================================

data/erlang/lib/misultin/src/misultin_websocket.erl

@@ -0,0 +1,252 @@
+% ==========================================================================================================
+% MISULTIN - WebSocket
+%
+% >-|-|-(°>
+% 
+% Copyright (C) 2010, Roberto Ostinelli <roberto@ostinelli.net>, Joe Armstrong.
+% All rights reserved.
+%
+% Code portions from Joe Armstrong have been originally taken under MIT license at the address:
+% <http://armstrongonsoftware.blogspot.com/2009/12/comet-is-dead-long-live-websockets.html>
+%
+% BSD License
+% 
+% Redistribution and use in source and binary forms, with or without modification, are permitted provided
+% that the following conditions are met:
+%
+%  * Redistributions of source code must retain the above copyright notice, this list of conditions and the
+%	 following disclaimer.
+%  * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
+%	 the following disclaimer in the documentation and/or other materials provided with the distribution.
+%  * Neither the name of the authors nor the names of its contributors may be used to endorse or promote
+%	 products derived from this software without specific prior written permission.
+%
+% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
+% WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+% PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+% ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+% TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+% HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+% NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+% POSSIBILITY OF SUCH DAMAGE.
+% ==========================================================================================================
+-module(misultin_websocket).
+-vsn("0.6.1").
+
+% API
+-export([check/2, connect/3]).
+
+
+% includes
+-include("../include/misultin.hrl").
+
+
+% ============================ \/ API ======================================================================
+
+% Function: {true, Origin, Host, Path} | false
+% Description: Check if the incoming request is a websocket handshake.
+check(_Path, Headers) ->
+	?LOG_DEBUG("testing for a websocket request path: ~p headers: ~p", [_Path, Headers]),
+	% set supported websocket protocols, order does matter
+	VsnSupported = [{'draft-hixie', 76}, {'draft-hixie', 68}],	
+	% checks
+	check_websockets(VsnSupported, Headers).
+
+% Connect and handshake with Websocket.
+connect(Req, #ws{vsn = Vsn, socket = Socket, socket_mode = SocketMode, path = Path, headers = Headers, ws_autoexit = WsAutoExit} = Ws, WsLoop) ->
+	?LOG_DEBUG("building handshake response", []),
+	% get data
+	Origin = misultin_utility:header_get_value('Origin', Headers),
+	Host = misultin_utility:header_get_value('Host', Headers),
+	% build handshake
+	HandshakeServer = handshake(Vsn, Req, Headers, {Path, Origin, Host}),
+	% send handshake back
+	misultin_socket:send(Socket, HandshakeServer, SocketMode),
+	% add data to ws record and spawn controlling process
+	Ws0 = misultin_ws:new(Ws#ws{origin = Origin, host = Host}, self()),
+	WsHandleLoopPid = spawn(fun() -> WsLoop(Ws0) end),
+	erlang:monitor(process, WsHandleLoopPid),
+	% set opts
+	misultin_socket:setopts(Socket, [{packet, 0}, {active, true}], SocketMode),
+	% add main websocket pid to misultin server reference
+	misultin:persistent_socket_pid_add(self()),
+	% start listening for incoming data
+	ws_loop(Socket, none, WsHandleLoopPid, SocketMode, WsAutoExit).	
+	
+% ============================ /\ API ======================================================================
+
+
+% ============================ \/ INTERNAL FUNCTIONS =======================================================
+
+% Description: Loop to check for all available supported websocket protocols.
+check_websockets([], _Headers) -> false;
+check_websockets([Vsn|T], Headers) ->
+	case check_websocket(Vsn, Headers) of
+		false -> check_websockets(T, Headers);
+		{true, Vsn} -> {true, Vsn}
+	end.
+
+% Function: {true, Vsn} | false
+% Description: Check if the incoming request is a websocket request.
+check_websocket({'draft-hixie', 76} = Vsn, Headers) ->
+	?LOG_DEBUG("testing for websocket protocol ~p", [Vsn]),
+	% set required headers
+	RequiredHeaders = [
+		{'Upgrade', "WebSocket"}, {'Connection', "Upgrade"}, {'Host', ignore}, {'Origin', ignore},
+		{'Sec-WebSocket-Key1', ignore}, {'Sec-WebSocket-Key2', ignore}
+	],
+	% check for headers existance
+	case check_headers(Headers, RequiredHeaders) of
+		true ->
+			% return
+			{true, Vsn};
+		_RemainingHeaders ->
+			?LOG_DEBUG("not protocol ~p, remaining headers: ~p", [Vsn, _RemainingHeaders]),
+			false
+	end;
+check_websocket({'draft-hixie', 68} = Vsn, Headers) ->
+	?LOG_DEBUG("testing for websocket protocol ~p", [Vsn]),
+	% set required headers
+	RequiredHeaders = [
+		{'Upgrade', "WebSocket"}, {'Connection', "Upgrade"}, {'Host', ignore}, {'Origin', ignore}
+	],
+	% check for headers existance
+	case check_headers(Headers, RequiredHeaders) of
+		true -> {true, Vsn};
+		_RemainingHeaders ->
+			?LOG_DEBUG("not protocol ~p, remaining headers: ~p", [Vsn, _RemainingHeaders]),
+			false
+	end;
+check_websocket(_Vsn, _Headers) -> false. % not implemented
+
+% Function: true | [{RequiredTag, RequiredVal}, ..]
+% Description: Check if headers correspond to headers requirements.
+check_headers(Headers, RequiredHeaders) ->
+	F = fun({Tag, Val}) ->
+		% see if the required Tag is in the Headers
+		case misultin_utility:header_get_value(Tag, Headers) of
+			false -> true; % header not found, keep in list
+			HVal ->
+				case Val of
+					ignore -> false; % ignore value -> ok, remove from list
+					HVal -> false;	 % expected val -> ok, remove from list
+					_ -> true		 % val is different, keep in list
+				end		
+		end
+	end,
+	case lists:filter(F, RequiredHeaders) of
+		[] -> true;
+		MissingHeaders -> MissingHeaders
+	end.
+
+% Function: List
+% Description: Builds the server handshake response.
+handshake({'draft-hixie', 76}, #req{socket = Sock, socket_mode = SocketMode}, Headers, {Path, Origin, Host}) ->
+	% build data
+	Key1 = misultin_utility:header_get_value('Sec-WebSocket-Key1', Headers),
+	Key2 = misultin_utility:header_get_value('Sec-WebSocket-Key2', Headers),
+	% handshake needs body of the request, still need to read it [TODO: default recv timeout hard set, will be exported when WS protocol is final]
+	misultin_socket:setopts(Sock, [{packet, raw}, {active, false}], SocketMode),
+	Body = case misultin_socket:recv(Sock, 8, 30*1000, SocketMode) of
+		{ok, Bin} -> Bin;
+		{error, timeout} ->
+			?LOG_WARNING("timeout in reading websocket body", []),
+			<<>>; 
+		_Other ->
+			?LOG_ERROR("tcp error treating data: ~p", [_Other]),
+			<<>>
+	end,
+	?LOG_DEBUG("got content in body of websocket request: ~p", [Body]),	
+	% prepare handhsake response
+	["HTTP/1.1 101 WebSocket Protocol Handshake\r\n",
+		"Upgrade: WebSocket\r\n",
+		"Connection: Upgrade\r\n",
+		"Sec-WebSocket-Origin: ", Origin, "\r\n",
+		"Sec-WebSocket-Location: ws://", lists:concat([Host, Path]), "\r\n\r\n",
+		build_challenge({'draft-hixie', 76}, {Key1, Key2, Body})
+	];
+handshake({'draft-hixie', 68}, _Req, _Headers, {Path, Origin, Host}) ->
+	% prepare handhsake response
+	["HTTP/1.1 101 Web Socket Protocol Handshake\r\n",
+		"Upgrade: WebSocket\r\n",
+		"Connection: Upgrade\r\n",
+		"WebSocket-Origin: ", Origin , "\r\n",
+		"WebSocket-Location: ws://", lists:concat([Host, Path]), "\r\n\r\n"
+	].
+
+% Function: List
+% Description: Builds the challenge for a handshake response.
+% Code portions from Sergio Veiga <http://sergioveiga.com/index.php/2010/06/17/websocket-handshake-76-in-erlang/>
+build_challenge({'draft-hixie', 76}, {Key1, Key2, Key3}) ->
+	Ikey1 = [D || D <- Key1, $0 =< D, D =< $9],
+	Ikey2 = [D || D <- Key2, $0 =< D, D =< $9],
+	Blank1 = length([D || D <- Key1, D =:= 32]),
+	Blank2 = length([D || D <- Key2, D =:= 32]),
+	Part1 = list_to_integer(Ikey1) div Blank1,
+	Part2 = list_to_integer(Ikey2) div Blank2,
+	Ckey = <<Part1:4/big-unsigned-integer-unit:8, Part2:4/big-unsigned-integer-unit:8, Key3/binary>>,
+	erlang:md5(Ckey).
+
+% Main Websocket loop
+ws_loop(Socket, Buffer, WsHandleLoopPid, SocketMode, WsAutoExit) ->
+	?LOG_DEBUG("websocket loop", []),
+	receive
+		{tcp, Socket, Data} ->
+			handle_data(Buffer, binary_to_list(Data), Socket, WsHandleLoopPid, SocketMode, WsAutoExit);
+		{tcp_closed, Socket} ->
+			?LOG_DEBUG("tcp connection was closed, exit", []),
+			% close websocket and custom controlling loop
+			websocket_close(Socket, WsHandleLoopPid, SocketMode, WsAutoExit);
+		{'DOWN', Ref, process, WsHandleLoopPid, Reason} ->
+			case Reason of
+				normal ->
+					?LOG_DEBUG("linked websocket controlling loop stopped.", []);
+				_ ->
+					?LOG_ERROR("linked websocket controlling loop crashed with reason: ~p", [Reason])
+			end,
+			% demonitor
+			erlang:demonitor(Ref),
+			% close websocket and custom controlling loop
+			websocket_close(Socket, WsHandleLoopPid, SocketMode, WsAutoExit);
+		{send, Data} ->
+			?LOG_DEBUG("sending data to websocket: ~p", [Data]),
+			misultin_socket:send(Socket, [0, Data, 255], SocketMode),
+			ws_loop(Socket, Buffer, WsHandleLoopPid, SocketMode, WsAutoExit);
+		shutdown ->
+			?LOG_DEBUG("shutdown request received, closing websocket with pid ~p", [self()]),
+			% close websocket and custom controlling loop
+			websocket_close(Socket, WsHandleLoopPid, SocketMode, WsAutoExit);
+		_Ignored ->
+			?LOG_WARNING("received unexpected message, ignoring: ~p", [_Ignored]),
+			ws_loop(Socket, Buffer, WsHandleLoopPid, SocketMode, WsAutoExit)
+	end.
+
+% Buffering and data handling
+handle_data(none, [0|T], Socket, WsHandleLoopPid, SocketMode, WsAutoExit) ->
+	handle_data([], T, Socket, WsHandleLoopPid, SocketMode, WsAutoExit);
+handle_data(none, [], Socket, WsHandleLoopPid, SocketMode, WsAutoExit) ->
+	ws_loop(Socket, none, WsHandleLoopPid, SocketMode, WsAutoExit);
+handle_data(L, [255|T], Socket, WsHandleLoopPid, SocketMode, WsAutoExit) ->
+	WsHandleLoopPid ! {browser, lists:reverse(L)},
+	handle_data(none, T, Socket, WsHandleLoopPid, SocketMode, WsAutoExit);
+handle_data(L, [H|T], Socket, WsHandleLoopPid, SocketMode, WsAutoExit) ->
+	handle_data([H|L], T, Socket, WsHandleLoopPid, SocketMode, WsAutoExit);
+handle_data([], L, Socket, WsHandleLoopPid, SocketMode, WsAutoExit) ->
+	ws_loop(Socket, L, WsHandleLoopPid, SocketMode, WsAutoExit).
+
+% Close socket and custom handling loop dependency
+websocket_close(Socket, WsHandleLoopPid, SocketMode, WsAutoExit) ->
+	% remove main websocket pid from misultin server reference
+	misultin:persistent_socket_pid_remove(self()),
+	case WsAutoExit of
+		true ->
+			% kill custom handling loop process
+			exit(WsHandleLoopPid, kill);
+		false ->
+			% the killing of the custom handling loop process is handled in the loop itself -> send event
+			WsHandleLoopPid ! closed
+	end,
+	% close main socket
+	misultin_socket:close(Socket, SocketMode).
+
+% ============================ /\ INTERNAL FUNCTIONS =======================================================