Compare commits

..

61 Commits

Author SHA1 Message Date
Björn Ritzl
3331ec1a8d Update index.md 2025-06-04 07:57:48 +02:00
Kharkunov Eugene
c4d744ec49
Fixed websocket library linkage for all web targets (#56) 2025-05-05 11:10:36 +02:00
Brian
de6d493a1c
Update README.md (#54) 2024-09-09 17:11:52 +02:00
Alexey Gulev
65b9e38850
Merge pull request #52 from ekharkunov/emscripten-update
Use builtin Emscripten webscoket implementation for html5.
2024-04-17 17:32:19 +02:00
Kharkunov Eugene
a75c9f6c8f Use builtin Emscripten webscoket implementation for html5.
Update .gitignore.
2024-04-10 13:45:27 +03:00
Mathias Westerdahl
0ac6e3f9a3
Removed hard length limit for received messages (#51) 2024-02-28 13:50:57 +01:00
Björn Ritzl
6ec47ddc17 Delete DefoldWebsocket.symbols 2022-11-02 13:57:59 +01:00
Björn Ritzl
24bb291c72
Added status code to callback when the server closes the connection (#45)
* Added WebSocket close code to callback

Also added message and code for HTML5

* Unify disconnect handling for wslay and html5
2022-06-23 20:52:46 +02:00
Björn Ritzl
5c5736d8bc
Update README.md 2022-02-24 08:27:30 +01:00
Björn Ritzl
24dd20512b
Update websocket.gui_script 2022-02-17 12:40:47 +01:00
Björn Ritzl
63cb5f8de6
Update websocket.gui_script 2022-02-17 12:40:15 +01:00
Björn Ritzl
ace3242158
Update index.md 2022-01-03 14:27:42 +01:00
Björn Ritzl
4cf11c3048
Added info about websocket configuration 2021-09-14 13:30:46 +02:00
Björn Ritzl
ecaac30238
Update README.md 2021-05-28 11:47:32 +02:00
Björn Ritzl
8fd283385f Merge branch 'Issue-38-crash-on-connect' 2021-05-28 11:37:23 +02:00
Björn Ritzl
dfc94aa94a Badge 2021-05-28 11:36:58 +02:00
JCash
d5237bbee1 Remove dold include dns.h 2021-05-01 10:13:36 +02:00
JCash
daffff4c06 Updated dmConnectionPool::Dial call for new beta release 2021-04-30 10:58:31 +02:00
VitaliiTihobrazov-Melsoft
0f841f16af
fix: the connection must be closed in other states (#41) 2021-04-12 22:45:09 +02:00
Björn Ritzl
97cca427d7
Reduced thread name length (#39)
pthread_setname_np() restricts thread name length to 16 characters.
2021-03-18 20:41:03 +01:00
Björn Ritzl
bc56b02e5b Reduced thread name length
pthread_setname_np() restricts thread name length to 16 characters.
2021-03-18 18:31:57 +01:00
Björn Ritzl
cba11de5f1
Run DNS lookup in a separate thread (#37)
* Moved connection pool dial to a thread
* Make sure to join the thread when done
* Cleanup in AppInitialize. Early exit if pool creation failed.
* Only check connection timeout for emscripten
2021-03-17 12:59:01 +01:00
Björn Ritzl
4e67c4dfaa
Add the port to the url for html5 builds (#35)
Fixes #34
2021-03-10 11:56:26 +01:00
Björn Ritzl
efe9115413
Use the Emscripten websocket library instead of POSIX socket emulation (#33)
* Switched to direct javascript websockets

* Skip the null termination on text messages when pushing

* Moved Emscripten callbacks and some other PR improvements

* STATE_CONNECT -> STATE_CREATE

* Changed disconnect logic

* Review feedback
2021-02-18 22:13:53 +01:00
Alexander Palagin
b3afb9a276
close socket when destroying websocket connection instead of returning it back to connection pool (#32) 2021-02-10 08:49:23 +01:00
Alexander Palagin
7346f142fa
replace dmStriCmp with dmStrCaseCmp (#31) 2021-02-10 07:50:09 +01:00
Alexander Palagin
165b7333dc
update exmaple of websocket_callback in documentation (#30) 2021-02-10 07:49:04 +01:00
JCash
bd4e5c0b35 Compiler warning fixes 2021-02-04 08:49:00 +01:00
Alexander Palagin
ac230a6278
Handshake response object if handshake failed (#29)
* added handshake response object, so if error occurs on websocket handhsake stage, server's response can be reachable for further decisions

* fixed typo; removed c++11 style constructors
2021-02-04 08:30:40 +01:00
Alexander Palagin
39abd7cdea
always call lua callback when connection goes to STATE_DISCONNECTED (#28) 2021-01-25 11:59:17 +01:00
Björn Ritzl
f988413a74 Fix logging in example when error is nil 2021-01-14 09:49:08 +01:00
JCash
73b236b249 Added ci build status badge to README.md 2020-12-24 14:22:07 +01:00
JCash
636a11daa3 Added ci build status badge to README.md 2020-12-24 14:20:08 +01:00
JCash
0f147ef180 Added auth/email to resolve step 2020-12-24 12:48:53 +01:00
Mathias Westerdahl
3cd0328c2a
Ci build script (#27)
* Added bob.yml

* Added all platforms

* Added macOS builder

* There's no jre on macOS

* jarsigner exists in the jdk

* Added pull_request_target

* Added cron job
2020-12-24 11:56:34 +01:00
Björn Ritzl
f5aa57452f
Merge pull request #26 from defold/Issue-25-crash-in-callback
Destroy connections when finalizing the extension
2020-12-22 12:21:20 +01:00
Björn Ritzl
7e89b8a685 Destroy connections when finalizing the extension 2020-12-22 12:19:12 +01:00
Mathias Westerdahl
ba7454a431
Merge pull request #24 from defold/issue-22-skip-protocol-by-default
Issue 22: Don't send Sec-WebSocket-Protocol unless specified
2020-11-10 08:42:30 +01:00
JCash
b93a91c9b8 Issue 22: Don't send Sec-WebSocket-Protocol unless specified 2020-11-09 19:03:27 +01:00
Mathias Westerdahl
0bf63cbdf8
Added credit and link to wslay 2020-11-01 09:28:27 +01:00
Mathias Westerdahl
8a9dc759a4
Merge pull request #21 from defold/issue-18-error-message-fix
Issue 18: Documentation fix
2020-10-31 15:48:47 +01:00
Mathias Westerdahl
70afde4cfa
Merge pull request #20 from defold/issue-17-path-fix
Issue 17: Fixed path argument in http handshake
2020-10-31 15:48:21 +01:00
Mathias Westerdahl
ed6d131470
Merge pull request #19 from defold/issue-16-conneciton-protocol
Issue 16: Added protocol as a connection parameter
2020-10-31 15:47:58 +01:00
JCash
2c9c0b74f1 Issue 18: Documentation fix 2020-10-31 10:55:36 +01:00
JCash
8450a88640 Issue 17: Fixed path argument in http handshake 2020-10-31 10:40:21 +01:00
JCash
3636ea73db added documentation 2020-10-31 10:18:50 +01:00
JCash
1cc1d802b3 Issue 16: Added protocol as a connection parameter 2020-10-31 10:14:44 +01:00
JCash
94bcc82f25 cleanup 2020-10-18 09:42:53 +02:00
JCash
d62a53cbcc Doc fix 2020-10-18 09:42:40 +02:00
Mathias Westerdahl
ea2fe97943
Merge pull request #15 from defold/issue-5-custom-headers
Issue 5: Added support for custom headers
2020-10-17 14:02:21 +02:00
Mathias Westerdahl
268e9bf472
Merge pull request #14 from defold/issue-13-connect-timeout
Issue 13: Added support for connect sequence timeout
2020-10-17 12:30:41 +02:00
Mathias Westerdahl
5ee358cbba
Merge pull request #12 from defold/issue-11-support-text-frames
Issue 11: Added support for both binary and text frames
2020-10-17 12:29:45 +02:00
JCash
78d527d3a8 Issue 5: Added support for custom headers 2020-10-17 12:26:20 +02:00
JCash
b54e3e07ad review fix 2020-10-17 11:47:23 +02:00
JCash
e105702c79 Issue 13: Added support for connect sequence timeout
Decreased the select timeout when reading headers
Don't call callback with DISCONNECTED if the connection was never connected
2020-10-17 11:40:53 +02:00
JCash
9d1ace0a82 Issue 11: Added support for both binary and text frames 2020-10-17 10:28:19 +02:00
Mathias Westerdahl
833477a134
Added another tcpdump example 2020-10-15 15:26:23 +02:00
Mathias Westerdahl
15a589585a
Added more debugging tools to README 2020-10-15 11:35:23 +02:00
Mathias Westerdahl
3fe8fbc0ff
Added external debugging tools to README 2020-10-15 10:39:50 +02:00
JCash
ba2b8e4a69 Updated hex string logging to use our internal logging functions
This will keep the output in-order
2020-10-13 09:33:38 +02:00
JCash
176f213060 updated documentation 2020-10-13 09:14:21 +02:00
17 changed files with 748 additions and 5859 deletions

76
.github/workflows/bob.yml vendored Normal file
View File

@ -0,0 +1,76 @@
name: Build with bob
on:
push:
pull_request_target:
schedule:
# nightly at 05:00 on the 1st and 15th
- cron: 0 5 1,15 * *
env:
VERSION_FILENAME: 'info.json'
BUILD_SERVER: 'https://build.defold.com'
jobs:
build_with_bob:
strategy:
matrix:
platform: [armv7-android, x86_64-linux, x86_64-win32, x86-win32, js-web]
runs-on: ubuntu-latest
name: Build
steps:
- uses: actions/checkout@v2
- uses: actions/setup-java@v1
with:
java-version: '11.0.2'
- name: Get Defold version
run: |
TMPVAR=`curl -s http://d.defold.com/stable/${{env.VERSION_FILENAME}} | jq -r '.sha1'`
echo "DEFOLD_VERSION=${TMPVAR}" >> $GITHUB_ENV
echo "Found version ${TMPVAR}"
- name: Download bob.jar
run: |
wget -q http://d.defold.com/archive/stable/${{env.DEFOLD_VERSION}}/bob/bob.jar
java -jar bob.jar --version
- name: Resolve libraries
run: java -jar bob.jar resolve --email a@b.com --auth 123456
- name: Build
run: java -jar bob.jar --platform=${{ matrix.platform }} build --archive --build-server=${{env.BUILD_SERVER}}
- name: Bundle
run: java -jar bob.jar --platform=${{ matrix.platform }} bundle
# macOS is not technically needed for building, but we want to test bundling as well, since we're also testing the manifest merging
build_with_bob_macos:
strategy:
matrix:
platform: [armv7-darwin, x86_64-darwin]
runs-on: macOS-latest
name: Build
steps:
- uses: actions/checkout@v2
- uses: actions/setup-java@v1
with:
java-version: '11.0.2'
- name: Get Defold version
run: |
TMPVAR=`curl -s http://d.defold.com/stable/${{env.VERSION_FILENAME}} | jq -r '.sha1'`
echo "DEFOLD_VERSION=${TMPVAR}" >> $GITHUB_ENV
echo "Found version ${TMPVAR}"
- name: Download bob.jar
run: |
wget -q http://d.defold.com/archive/stable/${{env.DEFOLD_VERSION}}/bob/bob.jar
java -jar bob.jar --version
- name: Resolve libraries
run: java -jar bob.jar resolve --email a@b.com --auth 123456
- name: Build
run: java -jar bob.jar --platform=${{ matrix.platform }} build --archive --build-server=${{env.BUILD_SERVER}}
- name: Bundle
run: java -jar bob.jar --platform=${{ matrix.platform }} bundle

View File

@ -1,6 +1,9 @@
name: Trigger site rebuild
on: [push]
on:
push:
branches:
- 'master'
jobs:
site-rebuild:

2
.gitignore vendored
View File

@ -12,3 +12,5 @@ builtins
lws_source
lws_build
*.profraw
*.der
/.editor_settings

View File

@ -1,5 +1,7 @@
# Defold websocket extension
[![Build Status](https://github.com/defold/extension-websocket/workflows/Build%20with%20bob/badge.svg)](https://github.com/defold/extension-websocket/actions)
## Installation
To use this library in your Defold project, add the following URL to your `game.project` dependencies:
@ -9,14 +11,51 @@ We recommend using a link to a zip file of a [specific release](https://github.c
## API reference
https://defold.com/extension-websocket/api/
https://defold.com/extension-websocket/
https://defold.com/extension-websocket/websocket_api/
## Debugging
In order to make it easier to debug this extension, we provide a `game.project` setting `websocket.debug`.
In order to make it easier to debug this extension, we provide a `game.project` setting `websocket.debug` (edit `game.project` as text and add):
```
[websocket]
debug = level
```
Set it to:
* `0` to disable debugging (i.e. no debug output).
* `1` to display state changes.
* `2` to display the messages sent and received.
## External resources
To verify that your websocket server works, you can test it with some tools.
* [websocat](https://github.com/vi/websocat)
Or, you can test your server on this web page:
* https://www.websocket.org/echo.html
To monitor all the packets sent to/from the client/server, you can use e.g.
* [Wireshark](https://www.wireshark.org)
For command line debugging, there's
* tcpdump: `sudo tcpdump -X -s0 -ilo0 port 8080 ` (example for local ws:// connection)
* tcpdump: `sudo tcpdump -X -s0 host echo.websocket.org` (Monitors packets to/from echo.websocket.org)
## Credits
This extension makes use of the C library WSlay by @tatsuhiro-t:
* https://github.com/tatsuhiro-t/wslay
The test server used by the example:
* https://www.lob.com/blog/websocket-org-is-down-here-is-an-alternative

File diff suppressed because it is too large Load Diff

View File

@ -14,19 +14,24 @@ Here is how you connect to a websocket and listen to events:
```lua
local function websocket_callback(self, conn, data)
if data.event == websocket.EVENT_DISCONNECTED then
print("disconnected " .. conn)
print("Disconnected: " .. tostring(conn))
self.connection = nil
update_gui(self)
elseif data.event == websocket.EVENT_CONNECTED then
print("Connected " .. conn)
-- self.connection = conn
update_gui(self)
print("Connected: " .. tostring(conn))
elseif data.event == websocket.EVENT_ERROR then
print("Error:", data.message)
print("Error: '" .. tostring(data.message) .. "'")
if data.handshake_response then
print("Handshake response status: '" .. tostring(data.handshake_response.status) .. "'")
for key, value in pairs(data.handshake_response.headers) do
log("Handshake response header: '" .. key .. ": " .. value .. "'")
end
print("Handshake response body: '" .. tostring(data.handshake_response.response) .. "'")
end
elseif data.event == websocket.EVENT_MESSAGE then
print("Receiving: '" .. tostring(data.message) .. "'")
end
elseif data.event == websocket.EVENT_DISCONNECTED then
print("Disconnected: '" .. tostring(data.message) .. "'")
end
end
function init(self)
@ -51,10 +56,19 @@ https://github.com/defold/extension-websocket/archive/master.zip
We recommend using a link to a zip file of a [specific release](https://github.com/defold/extension-websocket/releases).
## Configuration
The following configuration options can be set in the game.project file:
```
[websocket]
debug = 1
socket_timeout = 10000000
```
* `debug` - Log level where 0 means no logs and higher values shows more logs (currently 1 or 2).
* `socket_timeout` - Timeout for the underlying socket connection. In microseconds.
## Source code
The source code is available on [GitHub](https://github.com/defold/extension-websocket)
## API reference
https://defold.com/extension-websocket/api/

View File

@ -1,4 +1,4 @@
local URL="://echo.websocket.org"
local URL = "echo.websocket.events"
local function click_button(node, action)
return gui.is_enabled(node) and action.pressed and gui.pick_node(node, action.x, action.y)
@ -33,12 +33,6 @@ local function log(...)
gui.set_text(node, gui.get_text(node) .. "\n" .. text)
end
local function http_result(self, _, response)
print(response.status)
--print(response.response)
pprint(response.headers)
end
function init(self)
msg.post(".", "acquire_input_focus")
msg.post("@render:", "clear_color", { color = vmath.vector4(0.2, 0.4, 0.8, 1.0) })
@ -49,9 +43,6 @@ function init(self)
self.connection_text = gui.get_node("connection_text")
self.connection = nil
update_gui(self)
--http.request("https://defold.com", "GET", http_result)
end
function final(self)
@ -66,14 +57,21 @@ end
local function websocket_callback(self, conn, data)
if data.event == websocket.EVENT_DISCONNECTED then
log("Disconnected: " .. tostring(conn))
log("Disconnected: " .. tostring(conn) .. " Code: " .. data.code .. " Message: " .. tostring(data.message))
self.connection = nil
update_gui(self)
elseif data.event == websocket.EVENT_CONNECTED then
update_gui(self)
log("Connected: " .. tostring(conn))
elseif data.event == websocket.EVENT_ERROR then
log("Error: '" .. data.error .. "'")
log("Error: '" .. tostring(data.message) .. "'")
if data.handshake_response then
log("Handshake response status: '" .. tostring(data.handshake_response.status) .. "'")
for key, value in pairs(data.handshake_response.headers) do
log("Handshake response header: '" .. key .. ": " .. value .. "'")
end
log("Handshake response body: '" .. tostring(data.handshake_response.response) .. "'")
end
elseif data.event == websocket.EVENT_MESSAGE then
log("Receiving: '" .. tostring(data.message) .. "'")
end
@ -82,7 +80,7 @@ end
local function connect(self, scheme)
local params = {}
self.url = scheme .. URL
self.url = scheme .. "://" .. URL
log("Connecting to " .. self.url)
self.connection = websocket.connect(self.url, params, websocket_callback)
end

View File

@ -14,4 +14,3 @@ _dependencies = https://github.com/GameAnalytics/defold-openssl/archive/1.0.0.zi
[library]
include_dirs = websocket

View File

@ -17,6 +17,17 @@
type: table
desc: optional parameters as properties. The following parameters can be set
members:
- name: timeout
type: number
desc: Timeout for the connection sequence (milliseconds). Not used on HTML5. (Default is 3000)
- name: protocol
type: string
desc: the protocol to use (e.g. 'chat'). If not set, no `Sec-WebSocket-Protocol` header is sent.
- name: headers
type: string
desc: list of http headers. Each pair is separated with "\r\n". Not used on HTML5.
- name: callback
type: function
@ -48,11 +59,15 @@
- name: message
type: string
desc: The received data. Only valid if event is `websocket.EVENT_MESSAGE`
desc: The received data if event is `websocket.EVENT_MESSAGE`. Error message otherwise
- name: error
type: string
desc: The error string. Only valid if event is `websocket.EVENT_ERROR`
- name: handshake_response
type: table
desc: Handshake response information (status, headers etc)
- name: code
type: number
desc: Status code received from the server if the server closed the connection. Only present if event is `EVENT_DISCONNECTED`.
returns:
@ -65,21 +80,25 @@
```lua
local function websocket_callback(self, conn, data)
if data.event == websocket.EVENT_DISCONNECTED then
print("disconnected " .. conn)
log("Disconnected: " .. tostring(conn))
self.connection = nil
update_gui(self)
elseif data.event == websocket.EVENT_CONNECTED then
print("Connected " .. conn)
-- self.connection = conn
update_gui(self)
log("Connected: " .. tostring(conn))
elseif data.event == websocket.EVENT_ERROR then
print("Error:", data.error)
log("Error: '" .. data.message .. "'")
elseif data.event == websocket.EVENT_MESSAGE then
print("Receiving: '" .. tostring(data.message) .. "'")
log("Receiving: '" .. tostring(data.message) .. "'")
end
end
function init(self)
self.url = "ws://echo.websocket.org"
local params = {}
self.url = "ws://echo.websocket.events"
local params = {
timeout = 3000,
headers = "Sec-WebSocket-Protocol: chat\r\nOrigin: mydomain.com\r\n"
}
self.connection = websocket.connect(self.url, params, websocket_callback)
end
@ -112,6 +131,17 @@
- name: message
type: string
desc: the message to send
- name: options
type: table
desc: options for this particular message. May be `nil`
members:
- name: type
type: number
desc: The data type of the message
- `websocket.DATA_TYPE_BINARY` (default)
- `websocket.DATA_TYPE_TEXT`
examples:
- desc: |-

View File

@ -6,3 +6,7 @@ platforms:
context:
includes: ["upload/websocket/include/wslay"]
defines: ["HAVE_CONFIG_H"]
web:
context:
linkFlags: ["-lwebsocket.js"]

View File

@ -0,0 +1,42 @@
#include "websocket.h"
#if defined(__EMSCRIPTEN__)
namespace dmWebsocket
{
EM_BOOL Emscripten_WebSocketOnOpen(int eventType, const EmscriptenWebSocketOpenEvent *websocketEvent, void *userData) {
DebugLog(1, "WebSocket OnOpen");
WebsocketConnection* conn = (WebsocketConnection*)userData;
SetState(conn, STATE_CONNECTED);
HandleCallback(conn, EVENT_CONNECTED, 0, 0);
return EM_TRUE;
}
EM_BOOL Emscripten_WebSocketOnError(int eventType, const EmscriptenWebSocketErrorEvent *websocketEvent, void *userData) {
DebugLog(1, "WebSocket OnError");
WebsocketConnection* conn = (WebsocketConnection*)userData;
conn->m_Status = RESULT_ERROR;
SetState(conn, STATE_DISCONNECTED);
return EM_TRUE;
}
EM_BOOL Emscripten_WebSocketOnClose(int eventType, const EmscriptenWebSocketCloseEvent *websocketEvent, void *userData) {
DebugLog(1, "WebSocket OnClose");
WebsocketConnection* conn = (WebsocketConnection*)userData;
int length = strlen(websocketEvent->reason);
PushMessage(conn, MESSAGE_TYPE_CLOSE, length, (uint8_t*)websocketEvent->reason, websocketEvent->code);
return EM_TRUE;
}
EM_BOOL Emscripten_WebSocketOnMessage(int eventType, const EmscriptenWebSocketMessageEvent *websocketEvent, void *userData) {
DebugLog(1, "WebSocket OnMessage");
WebsocketConnection* conn = (WebsocketConnection*)userData;
int length = websocketEvent->numBytes;
if (websocketEvent->isText)
{
length--;
}
PushMessage(conn, MESSAGE_TYPE_NORMAL, length, websocketEvent->data, 0);
return EM_TRUE;
}
} // namespace
#endif // __EMSCRIPTEN__

View File

@ -1,5 +1,6 @@
#include "websocket.h"
#include <dmsdk/dlib/socket.h>
#include <dmsdk/dlib/http_client.h>
#include <ctype.h> // tolower
namespace dmWebsocket
@ -40,8 +41,12 @@ static Result SendClientHandshakeHeaders(WebsocketConnection* conn)
dmSnPrintf(port, sizeof(port), ":%d", conn->m_Url.m_Port);
dmSocket::Result sr;
WS_SENDALL("GET /");
WS_SENDALL("GET ");
if (conn->m_Url.m_Path[0] == '\0') {
WS_SENDALL("/"); // Default to / for empty path
} else {
WS_SENDALL(conn->m_Url.m_Path);
}
WS_SENDALL(" HTTP/1.1\r\n");
WS_SENDALL("Host: ");
WS_SENDALL(conn->m_Url.m_Hostname);
@ -54,9 +59,23 @@ static Result SendClientHandshakeHeaders(WebsocketConnection* conn)
WS_SENDALL("\r\n");
WS_SENDALL("Sec-WebSocket-Version: 13\r\n");
// Add custom protocols
if (conn->m_CustomHeaders)
{
WS_SENDALL(conn->m_CustomHeaders);
// make sure we ended with '\r\n'
int len = strlen(conn->m_CustomHeaders);
bool ended_with_sentinel = len >= 2 && conn->m_CustomHeaders[len - 2] == '\r' && conn->m_CustomHeaders[len - 1] == '\n';
if (!ended_with_sentinel)
{
WS_SENDALL("\r\n");
}
}
// Add custom headers
if (conn->m_Protocol) {
WS_SENDALL("Sec-WebSocket-Protocol: ");
WS_SENDALL(conn->m_Protocol);
WS_SENDALL("\r\n");
}
WS_SENDALL("\r\n");
@ -101,17 +120,12 @@ Result ReceiveHeaders(WebsocketConnection* conn)
#else
Result ReceiveHeaders(WebsocketConnection* conn)
{
dmSocket::Selector selector;
dmSocket::SelectorZero(&selector);
dmSocket::SelectorSet(&selector, dmSocket::SELECTOR_KIND_READ, conn->m_Socket);
dmSocket::Result sr = dmSocket::Select(&selector, 200*1000);
dmSocket::Result sr = WaitForSocket(conn, dmSocket::SELECTOR_KIND_READ, SOCKET_WAIT_TIMEOUT);
if (dmSocket::RESULT_OK != sr)
{
if (dmSocket::RESULT_WOULDBLOCK)
{
dmLogWarning("Waiting for socket to be available for reading");
DebugLog(2, "Waiting for socket to be available for reading");
return RESULT_WOULDBLOCK;
}
@ -157,69 +171,37 @@ Result ReceiveHeaders(WebsocketConnection* conn)
}
#endif
static int dmStriCmp(const char* s1, const char* s2)
static void HandleVersion(void* user_data, int major, int minor, int status, const char* status_str)
{
for (;;)
{
if (!*s1 || !*s2 || tolower((unsigned char) *s1) != tolower((unsigned char) *s2))
{
return (unsigned char) *s1 - (unsigned char) *s2;
}
s1++;
s2++;
}
HandshakeResponse* response = (HandshakeResponse*)user_data;
response->m_HttpMajor = major;
response->m_HttpMinor = minor;
response->m_ResponseStatusCode = status;
}
#if defined(__EMSCRIPTEN__)
Result VerifyHeaders(WebsocketConnection* conn)
static void HandleHeader(void* user_data, const char* key, const char* value)
{
return RESULT_OK;
}
#else
Result VerifyHeaders(WebsocketConnection* conn)
{
char* r = conn->m_Buffer;
// According to protocol, the response should start with "HTTP/1.1 <statuscode> <message>"
const char* http_version_and_status_protocol = "HTTP/1.1 101";
if (strstr(r, http_version_and_status_protocol) != r) {
return SetStatus(conn, RESULT_HANDSHAKE_FAILED, "Missing: '%s' in header", http_version_and_status_protocol);
HandshakeResponse* response = (HandshakeResponse*)user_data;
if (response->m_Headers.Remaining() == 0)
{
response->m_Headers.OffsetCapacity(4);
}
HttpHeader* new_header = new HttpHeader(key, value);
const char* endtag = strstr(conn->m_Buffer, "\r\n\r\n");
response->m_Headers.Push(new_header);
}
r = strstr(r, "\r\n") + 2;
bool connection = false;
bool upgrade = false;
bool valid_key = false;
const char* protocol = "";
static void HandleContent(void* user_data, int offset)
{
HandshakeResponse* response = (HandshakeResponse*)user_data;
response->m_BodyOffset = offset;
}
// TODO: Perhaps also support the Sec-WebSocket-Protocol
// parse the headers in place
while (r < endtag)
{
// Tokenize the each header line: "Key: Value\r\n"
const char* key = r;
r = strchr(r, ':');
*r = 0;
++r;
const char* value = r;
while(*value == ' ')
++value;
r = strstr(r, "\r\n");
*r = 0;
r += 2;
// Page 18 in https://tools.ietf.org/html/rfc6455#section-11.3.3
if (dmStriCmp(key, "Connection") == 0 && dmStriCmp(value, "Upgrade") == 0)
connection = true;
else if (dmStriCmp(key, "Upgrade") == 0 && dmStriCmp(value, "websocket") == 0)
upgrade = true;
else if (dmStriCmp(key, "Sec-WebSocket-Accept") == 0)
{
bool ValidateSecretKey(WebsocketConnection* conn, const char* server_key)
{
uint8_t client_key[32 + 40];
uint32_t client_key_len = sizeof(client_key);
dmCrypt::Base64Encode(conn->m_Key, sizeof(conn->m_Key), client_key, &client_key_len);
@ -241,24 +223,48 @@ Result VerifyHeaders(WebsocketConnection* conn)
client_key_len = sizeof(client_key);
dmCrypt::Base64Encode(client_key_sha1, sizeof(client_key_sha1), client_key, &client_key_len);
client_key[client_key_len] = 0;
DebugLog(2, "Client key (base64): %s", client_key);
DebugLog(2, "Server key (base64): %s", server_key);
DebugLog(2, "Server key (base64): %s", value);
return strcmp(server_key, (const char*)client_key) == 0;
}
if (strcmp(value, (const char*)client_key) == 0)
valid_key = true;
}
#if defined(__EMSCRIPTEN__)
Result VerifyHeaders(WebsocketConnection* conn)
{
return RESULT_OK;
}
#else
Result VerifyHeaders(WebsocketConnection* conn)
{
char* r = conn->m_Buffer;
// Find start of payload now because dmHttpClient::ParseHeader is destructive
const char* start_of_payload = strstr(conn->m_Buffer, "\r\n\r\n");
start_of_payload += 4;
HandshakeResponse* response = new HandshakeResponse();
conn->m_HandshakeResponse = response;
dmHttpClient::ParseResult parse_result = dmHttpClient::ParseHeader(r, response, true, &HandleVersion, &HandleHeader, &HandleContent);
if (parse_result != dmHttpClient::ParseResult::PARSE_RESULT_OK)
{
return SetStatus(conn, RESULT_HANDSHAKE_FAILED, "Failed to parse handshake response. 'dmHttpClient::ParseResult=%i'", parse_result);
}
// The response might contain both the headers, but also (if successful) the first batch of data
endtag += 4;
uint32_t size = conn->m_BufferSize - (endtag - conn->m_Buffer);
conn->m_BufferSize = size;
memmove(conn->m_Buffer, endtag, size);
conn->m_Buffer[size] = 0;
conn->m_HasHandshakeData = conn->m_BufferSize != 0 ? 1 : 0;
if (response->m_ResponseStatusCode != 101) {
return SetStatus(conn, RESULT_HANDSHAKE_FAILED, "Wrong response status: %i", response->m_ResponseStatusCode);
}
HttpHeader *connection_header, *upgrade_header, *websocket_secret_header;
connection_header = response->GetHeader("Connection");
upgrade_header = response->GetHeader("Upgrade");
websocket_secret_header = response->GetHeader("Sec-WebSocket-Accept");
bool connection = connection_header && dmStrCaseCmp(connection_header->m_Value, "Upgrade") == 0;
bool upgrade = upgrade_header && dmStrCaseCmp(upgrade_header->m_Value, "websocket") == 0;
bool valid_key = websocket_secret_header && ValidateSecretKey(conn, websocket_secret_header->m_Value);
// Send error to lua?
if (!connection)
dmLogError("Failed to find the Connection keyword in the response headers");
if (!upgrade)
@ -267,11 +273,21 @@ Result VerifyHeaders(WebsocketConnection* conn)
dmLogError("Failed to find valid key in the response headers");
bool ok = connection && upgrade && valid_key;
if (!ok) {
dmLogError("Response:\n\"%s\"\n", conn->m_Buffer);
if(!ok)
{
return RESULT_HANDSHAKE_FAILED;
}
return ok ? RESULT_OK : RESULT_HANDSHAKE_FAILED;
delete conn->m_HandshakeResponse;
conn->m_HandshakeResponse = 0;
// The response might contain both the headers, but also (if successful) the first batch of data
uint32_t size = conn->m_BufferSize - (start_of_payload - conn->m_Buffer);
conn->m_BufferSize = size;
memmove(conn->m_Buffer, start_of_payload, size);
conn->m_Buffer[size] = 0;
conn->m_HasHandshakeData = conn->m_BufferSize != 0 ? 1 : 0;
return RESULT_OK;
}
#endif

View File

@ -1,8 +1,8 @@
#include "script_util.h"
namespace dmWebsocket {
namespace dmScript {
bool luaL_checkbool(lua_State *L, int numArg)
bool CheckBool(lua_State *L, int numArg)
{
bool b = false;
if (lua_isboolean(L, numArg))
@ -16,17 +16,17 @@ bool luaL_checkbool(lua_State *L, int numArg)
return b;
}
bool luaL_checkboold(lua_State *L, int numArg, int def)
bool CheckBoold(lua_State *L, int numArg, int def)
{
int type = lua_type(L, numArg);
if (type != LUA_TNONE && type != LUA_TNIL)
{
return luaL_checkbool(L, numArg);
return CheckBool(L, numArg);
}
return def;
}
lua_Number luaL_checknumberd(lua_State *L, int numArg, lua_Number def)
lua_Number CheckNumberd(lua_State *L, int numArg, lua_Number def)
{
int type = lua_type(L, numArg);
if (type != LUA_TNONE && type != LUA_TNIL)
@ -36,7 +36,7 @@ lua_Number luaL_checknumberd(lua_State *L, int numArg, lua_Number def)
return def;
}
char* luaL_checkstringd(lua_State *L, int numArg, const char* def)
char* CheckStringd(lua_State *L, int numArg, const char* def)
{
int type = lua_type(L, numArg);
if (type != LUA_TNONE && type != LUA_TNIL)
@ -46,7 +46,7 @@ char* luaL_checkstringd(lua_State *L, int numArg, const char* def)
return (char*)def;
}
lua_Number luaL_checktable_number(lua_State *L, int numArg, const char* field, lua_Number def)
lua_Number CheckTableNumber(lua_State *L, int numArg, const char* field, lua_Number def)
{
lua_Number result = def;
if(lua_istable(L, numArg))
@ -61,7 +61,7 @@ lua_Number luaL_checktable_number(lua_State *L, int numArg, const char* field, l
return result;
}
char* luaL_checktable_string(lua_State *L, int numArg, const char* field, char* def)
char* CheckTableString(lua_State *L, int numArg, const char* field, char* def)
{
char* result = def;
if(lua_istable(L, numArg))

View File

@ -2,11 +2,11 @@
#include <dmsdk/sdk.h>
namespace dmWebsocket {
bool luaL_checkbool(lua_State *L, int numArg);
bool luaL_checkboold(lua_State *L, int numArg, int def);
lua_Number luaL_checknumberd(lua_State *L, int numArg, lua_Number def);
char* luaL_checkstringd(lua_State *L, int numArg, const char* def);
lua_Number luaL_checktable_number(lua_State *L, int numArg, const char* field, lua_Number def);
char* luaL_checktable_string(lua_State *L, int numArg, const char* field, char* def);
namespace dmScript {
bool CheckBool(lua_State *L, int numArg);
bool CheckBoold(lua_State *L, int numArg, int def);
lua_Number CheckNumberd(lua_State *L, int numArg, lua_Number def);
char* CheckStringd(lua_State *L, int numArg, const char* def);
lua_Number CheckTableNumber(lua_State *L, int numArg, const char* field, lua_Number def);
char* CheckTableString(lua_State *L, int numArg, const char* field, char* def);
} // namespace

View File

@ -7,12 +7,13 @@
#include "websocket.h"
#include "script_util.h"
#include <dmsdk/dlib/connection_pool.h>
#include <dmsdk/dlib/dns.h>
#include <dmsdk/dlib/thread.h>
#include <dmsdk/dlib/sslsocket.h>
#include <ctype.h> // isprint et al
#if defined(__EMSCRIPTEN__)
#include <emscripten/emscripten.h> // for EM_ASM
#include <emscripten/websocket.h>
#endif
#if defined(WIN32)
@ -30,14 +31,10 @@ struct WebsocketContext
int m_Timeout;
dmArray<WebsocketConnection*> m_Connections;
dmConnectionPool::HPool m_Pool;
dmDNS::HChannel m_Channel;
uint32_t m_Initialized:1;
} g_Websocket;
static void HandleCallback(WebsocketConnection* conn, int event);
#define STRING_CASE(_X) case _X: return #_X;
const char* ResultToString(Result err)
@ -56,10 +53,12 @@ const char* ResultToString(Result err)
const char* StateToString(State err)
{
switch(err) {
STRING_CASE(STATE_CREATE);
STRING_CASE(STATE_CONNECTING);
STRING_CASE(STATE_HANDSHAKE_WRITE);
STRING_CASE(STATE_HANDSHAKE_READ);
STRING_CASE(STATE_CONNECTED);
STRING_CASE(STATE_DISCONNECTING);
STRING_CASE(STATE_DISCONNECTED);
default: return "Unknown error";
};
@ -87,23 +86,50 @@ void DebugPrint(int level, const char* msg, const void* _bytes, uint32_t num_byt
if (level > g_DebugWebSocket)
return;
char buffer[1024];
char submessage[128];
uint32_t sublength = 0;
uint32_t len = dmSnPrintf(buffer, sizeof(buffer), "%s '", msg);
const uint8_t* bytes = (const uint8_t*)_bytes;
printf("%s '", msg);
for (uint32_t i = 0; i < num_bytes; ++i)
{
if (len + 2 >= sizeof(buffer))
{
dmLogWarning("%s", buffer);
buffer[0] = 0;
len = 0;
}
sublength = 0;
int c = bytes[i];
if (isprint(c))
printf("%c", c);
sublength = dmSnPrintf(submessage, sizeof(submessage), "%c", c);
else if (c == '\r')
printf("\\r");
sublength = dmSnPrintf(submessage, sizeof(submessage), "\\r");
else if (c == '\n')
printf("\\n");
sublength = dmSnPrintf(submessage, sizeof(submessage), "\\n");
else if (c == '\t')
printf("\\t");
sublength = dmSnPrintf(submessage, sizeof(submessage), "\\t");
else
printf("\\%02x", c);
sublength = dmSnPrintf(submessage, sizeof(submessage), "\\%02x", c);
dmStrlCat(buffer, submessage, sizeof(buffer));
len += sublength;
}
printf("' %u bytes\n", num_bytes);
if (len + 2 >= sizeof(buffer))
{
dmLogWarning("%s", buffer);
buffer[0] = 0;
len = 0;
}
sublength = dmSnPrintf(submessage, sizeof(submessage), "' %u bytes", num_bytes);
dmStrlCat(buffer, submessage, sizeof(buffer));
len += sublength;
dmLogWarning("%s", buffer);
}
@ -112,7 +138,7 @@ void DebugPrint(int level, const char* msg, const void* _bytes, uint32_t num_byt
CloseConnection(conn);
static void SetState(WebsocketConnection* conn, State state)
void SetState(WebsocketConnection* conn, State state)
{
State prev_state = conn->m_State;
if (prev_state != state)
@ -142,8 +168,6 @@ Result SetStatus(WebsocketConnection* conn, Result status, const char* format, .
// ***************************************************************************************************
// LUA functions
static WebsocketConnection* CreateConnection(const char* url)
{
WebsocketConnection* conn = new WebsocketConnection;
@ -151,15 +175,15 @@ static WebsocketConnection* CreateConnection(const char* url)
conn->m_Buffer = (char*)malloc(conn->m_BufferCapacity);
conn->m_Buffer[0] = 0;
conn->m_BufferSize = 0;
conn->m_ConnectTimeout = 0;
dmURI::Parts uri;
dmURI::Parse(url, &conn->m_Url);
if (strcmp(conn->m_Url.m_Scheme, "https") == 0)
strcpy(conn->m_Url.m_Scheme, "wss");
conn->m_SSL = strcmp(conn->m_Url.m_Scheme, "wss") == 0 ? 1 : 0;
conn->m_State = STATE_CONNECTING;
conn->m_State = STATE_CREATE;
conn->m_Callback = 0;
conn->m_Connection = 0;
@ -167,10 +191,15 @@ static WebsocketConnection* CreateConnection(const char* url)
conn->m_SSLSocket = 0;
conn->m_Status = RESULT_OK;
conn->m_HasHandshakeData = 0;
conn->m_HandshakeResponse = 0;
conn->m_ConnectionThread = 0;
#if defined(HAVE_WSLAY)
conn->m_Ctx = 0;
#endif
#if defined(__EMSCRIPTEN__)
conn->m_WS = 0;
#endif
return conn;
}
@ -182,48 +211,72 @@ static void DestroyConnection(WebsocketConnection* conn)
WSL_Exit(conn->m_Ctx);
#endif
free((void*)conn->m_CustomHeaders);
free((void*)conn->m_Protocol);
if (conn->m_Callback)
dmScript::DestroyCallback(conn->m_Callback);
#if defined(__EMSCRIPTEN__)
if (conn->m_Socket != dmSocket::INVALID_SOCKET_HANDLE) {
// We would normally do a shutdown() first, but Emscripten returns ENOSYS
//dmSocket::Shutdown(conn->m_Socket, dmSocket::SHUTDOWNTYPE_READWRITE);
dmSocket::Delete(conn->m_Socket);
if (conn->m_WS)
{
emscripten_websocket_delete(conn->m_WS);
}
#else
if (conn->m_Connection)
dmConnectionPool::Return(g_Websocket.m_Pool, conn->m_Connection);
dmConnectionPool::Close(g_Websocket.m_Pool, conn->m_Connection);
#endif
if (conn->m_HandshakeResponse)
delete conn->m_HandshakeResponse;
free((void*)conn->m_Buffer);
if (conn->m_ConnectionThread)
{
dmThread::Join(conn->m_ConnectionThread);
conn->m_ConnectionThread = 0;
}
delete conn;
DebugLog(2, "DestroyConnection: %p", conn);
}
static void CloseConnection(WebsocketConnection* conn)
{
State prev_state = conn->m_State;
// we want it to send this message in the polling
if (conn->m_State == STATE_CONNECTED) {
#if defined(HAVE_WSLAY)
WSL_Close(conn->m_Ctx);
#else
// start disconnecting by closing the WebSocket through the JS API
// we transition to the DISCONNECTED state when we receive the
// Emscripten callback that the connection has closed
emscripten_websocket_close(conn->m_WS, 1000, "CloseConnection");
SetState(conn, STATE_DISCONNECTING);
#endif
}
#if defined(HAVE_WSLAY)
// close the connection and immediately transition to the DISCONNECTED
// state
SetState(conn, STATE_DISCONNECTED);
#endif
}
static int FindConnection(WebsocketConnection* conn)
static bool IsConnectionValid(WebsocketConnection* conn)
{
if (conn)
{
for (int i = 0; i < g_Websocket.m_Connections.Size(); ++i )
{
if (g_Websocket.m_Connections[i] == conn)
return i;
return true;
}
return -1;
}
return false;
}
/*#
@ -237,13 +290,22 @@ static int LuaConnect(lua_State* L)
return DM_LUA_ERROR("The web socket module isn't initialized");
const char* url = luaL_checkstring(L, 1);
lua_Number timeout = dmScript::CheckTableNumber(L, 2, "timeout", 3000);
const char* custom_headers = dmScript::CheckTableString(L, 2, "headers", 0);
const char* protocol = dmScript::CheckTableString(L, 2, "protocol", 0);
// long playedTime = luaL_checktable_number(L, 2, "playedTime", -1);
// long progressValue = luaL_checktable_number(L, 2, "progressValue", -1);
// char *description = luaL_checktable_string(L, 2, "description", NULL);
// char *coverImage = luaL_checktable_string(L, 2, "coverImage", NULL);
if (custom_headers != 0)
{
if (strstr(custom_headers, "\r\n\r\n") != 0)
{
return DM_LUA_ERROR("The header field must not contain double '\\r\\n\\r\\n': '%s'", custom_headers);
}
}
WebsocketConnection* conn = CreateConnection(url);
conn->m_ConnectTimeout = dmTime::GetTime() + timeout * 1000;
conn->m_CustomHeaders = custom_headers ? strdup(custom_headers) : 0;
conn->m_Protocol = protocol ? strdup(protocol) : 0;
conn->m_Callback = dmScript::CreateCallback(L, 3);
@ -267,8 +329,7 @@ static int LuaDisconnect(lua_State* L)
WebsocketConnection* conn = (WebsocketConnection*)lua_touserdata(L, 1);
int i = FindConnection(conn);
if (i != -1)
if (IsConnectionValid(conn))
{
CloseConnection(conn);
}
@ -287,8 +348,7 @@ static int LuaSend(lua_State* L)
WebsocketConnection* conn = (WebsocketConnection*)lua_touserdata(L, 1);
int i = FindConnection(conn);
if (i == -1)
if (!IsConnectionValid(conn))
return DM_LUA_ERROR("Invalid connection");
if (conn->m_State != STATE_CONNECTED)
@ -298,7 +358,7 @@ static int LuaSend(lua_State* L)
const char* string = luaL_checklstring(L, 2, &string_length);
#if defined(HAVE_WSLAY)
int write_mode = WSLAY_BINARY_FRAME; // or WSLAY_TEXT_FRAME
int write_mode = dmScript::CheckTableNumber(L, 3, "type", WSLAY_BINARY_FRAME);
struct wslay_event_msg msg;
msg.opcode = write_mode;
@ -307,9 +367,17 @@ static int LuaSend(lua_State* L)
wslay_event_queue_msg(conn->m_Ctx, &msg); // it makes a copy of the data
#else
dmSocket::Result sr = Send(conn, string, string_length, 0);
if (dmSocket::RESULT_OK != sr)
EMSCRIPTEN_RESULT result;
int write_mode = dmScript::CheckTableNumber(L, 3, "type", DATA_TYPE_BINARY);
if (write_mode == DATA_TYPE_BINARY)
{
result = emscripten_websocket_send_binary(conn->m_WS, (void*)string, string_length);
}
else
{
result = emscripten_websocket_send_utf8_text(conn->m_WS, string);
}
if (result)
{
CLOSE_CONN("Failed to send on websocket");
}
@ -318,7 +386,7 @@ static int LuaSend(lua_State* L)
return 0;
}
static void HandleCallback(WebsocketConnection* conn, int event, int msg_offset, int msg_length)
void HandleCallback(WebsocketConnection* conn, int event, int msg_offset, int msg_length)
{
if (!dmScript::IsCallbackValid(conn->m_Callback))
return;
@ -342,12 +410,80 @@ static void HandleCallback(WebsocketConnection* conn, int event, int msg_offset,
lua_pushlstring(L, conn->m_Buffer + msg_offset, msg_length);
lua_setfield(L, -2, "message");
if(conn->m_HandshakeResponse)
{
HandshakeResponse* response = conn->m_HandshakeResponse;
lua_newtable(L);
lua_pushnumber(L, response->m_ResponseStatusCode);
lua_setfield(L, -2, "status");
lua_pushstring(L, &conn->m_Buffer[response->m_BodyOffset]);
lua_setfield(L, -2, "response");
lua_newtable(L);
for (uint32_t i = 0; i < response->m_Headers.Size(); ++i)
{
lua_pushstring(L, response->m_Headers[i]->m_Value);
lua_setfield(L, -2, response->m_Headers[i]->m_Key);
}
lua_setfield(L, -2, "headers");
lua_setfield(L, -2, "handshake_response");
delete conn->m_HandshakeResponse;
conn->m_HandshakeResponse = 0;
}
if (event == EVENT_DISCONNECTED)
{
lua_pushinteger(L, conn->m_CloseCode);
lua_setfield(L, -2, "code");
}
dmScript::PCall(L, 3, 0);
dmScript::TeardownCallback(conn->m_Callback);
}
HttpHeader::HttpHeader(const char* key, const char* value)
{
m_Key = strdup(key);
m_Value = strdup(value);
}
HttpHeader::~HttpHeader()
{
free((void*)m_Key);
free((void*)m_Value);
m_Key = 0;
m_Value = 0;
}
HttpHeader* HandshakeResponse::GetHeader(const char* header_key)
{
for(uint32_t i = 0; i < m_Headers.Size(); ++i)
{
if (dmStrCaseCmp(m_Headers[i]->m_Key, header_key) == 0)
{
return m_Headers[i];
}
}
return 0;
}
HandshakeResponse::~HandshakeResponse()
{
for(uint32_t i = 0; i < m_Headers.Size(); ++i)
{
delete m_Headers[i];
}
}
// ***************************************************************************************************
// Life cycle functions
@ -376,6 +512,16 @@ static void LuaInit(lua_State* L)
SETCONSTANT(EVENT_MESSAGE);
SETCONSTANT(EVENT_ERROR);
#if defined(HAVE_WSLAY)
lua_pushnumber(L, (lua_Number) WSLAY_BINARY_FRAME);
lua_setfield(L, -2, "DATA_TYPE_BINARY");
lua_pushnumber(L, (lua_Number) WSLAY_TEXT_FRAME);
lua_setfield(L, -2, "DATA_TYPE_TEXT");
#else
SETCONSTANT(DATA_TYPE_BINARY);
SETCONSTANT(DATA_TYPE_TEXT);
#endif
#undef SETCONSTANT
lua_pop(L, 1);
@ -387,8 +533,8 @@ static dmExtension::Result AppInitialize(dmExtension::AppParams* params)
g_Websocket.m_BufferSize = dmConfigFile::GetInt(params->m_ConfigFile, "websocket.buffer_size", 64 * 1024);
g_Websocket.m_Timeout = dmConfigFile::GetInt(params->m_ConfigFile, "websocket.socket_timeout", 500 * 1000);
g_Websocket.m_Connections.SetCapacity(4);
g_Websocket.m_Channel = 0;
g_Websocket.m_Pool = 0;
g_Websocket.m_Initialized = 0;
dmConnectionPool::Params pool_params;
pool_params.m_MaxConnections = dmConfigFile::GetInt(params->m_ConfigFile, "websocket.max_connections", 2);
@ -401,39 +547,10 @@ static dmExtension::Result AppInitialize(dmExtension::AppParams* params)
if (dmConnectionPool::RESULT_OK != result)
{
dmLogError("Failed to create connection pool: %d", result);
return dmExtension::RESULT_INIT_ERROR;
}
// We can do without the channel, it will then fallback to the dmSocket::GetHostname (as opposed to dmDNS::GetHostname)
#if defined(HAVE_WSLAY)
dmDNS::Result dns_result = dmDNS::NewChannel(&g_Websocket.m_Channel);
if (dmDNS::RESULT_OK != dns_result)
{
dmLogError("Failed to create connection pool: %d", dns_result);
}
#endif
#if defined(__EMSCRIPTEN__)
// avoid mixed content warning if trying to access wss resource from http page
// If not using this, we get EHOSTUNREACH
EM_ASM({
Module["websocket"].url = window["location"]["protocol"].replace("http", "ws") + "//";
});
#endif
g_Websocket.m_Initialized = 1;
if (!g_Websocket.m_Pool)
{
if (!g_Websocket.m_Pool)
{
dmLogInfo("pool is null!");
dmConnectionPool::Delete(g_Websocket.m_Pool);
}
dmLogInfo("%s extension not initialized", MODULE_NAME);
g_Websocket.m_Initialized = 0;
}
return dmExtension::RESULT_OK;
}
@ -450,17 +567,22 @@ static dmExtension::Result Initialize(dmExtension::Params* params)
static dmExtension::Result AppFinalize(dmExtension::AppParams* params)
{
dmConnectionPool::Shutdown(g_Websocket.m_Pool, dmSocket::SHUTDOWNTYPE_READWRITE);
return dmExtension::RESULT_OK;
}
static dmExtension::Result Finalize(dmExtension::Params* params)
{
while (!g_Websocket.m_Connections.Empty())
{
WebsocketConnection* conn = g_Websocket.m_Connections.Back();
g_Websocket.m_Connections.Pop();
DestroyConnection(conn);
}
return dmExtension::RESULT_OK;
}
Result PushMessage(WebsocketConnection* conn, MessageType type, int length, const uint8_t* buffer)
Result PushMessage(WebsocketConnection* conn, MessageType type, int length, const uint8_t* buffer, uint16_t code)
{
if (conn->m_Messages.Full())
conn->m_Messages.OffsetCapacity(4);
@ -468,11 +590,9 @@ Result PushMessage(WebsocketConnection* conn, MessageType type, int length, cons
Message msg;
msg.m_Type = (uint32_t)type;
msg.m_Length = length;
msg.m_Code = code;
conn->m_Messages.Push(msg);
// No need to copy itself (html5)
if (buffer != (const uint8_t*)conn->m_Buffer)
{
if ((conn->m_BufferSize + length) >= conn->m_BufferCapacity)
{
conn->m_BufferCapacity = conn->m_BufferSize + length + 1;
@ -480,7 +600,6 @@ Result PushMessage(WebsocketConnection* conn, MessageType type, int length, cons
}
// append to the end of the buffer
memcpy(conn->m_Buffer + conn->m_BufferSize, buffer, length);
}
conn->m_BufferSize += length;
conn->m_Buffer[conn->m_BufferCapacity-1] = 0;
@ -491,6 +610,26 @@ Result PushMessage(WebsocketConnection* conn, MessageType type, int length, cons
return dmWebsocket::RESULT_OK;
}
// has the connect procedure taken too long?
static bool CheckConnectTimeout(WebsocketConnection* conn)
{
uint64_t t = dmTime::GetTime();
return t >= conn->m_ConnectTimeout;
}
static void ConnectionWorker(void* _conn)
{
WebsocketConnection* conn = (WebsocketConnection*)_conn;
dmSocket::Result sr;
dmConnectionPool::Result pool_result = dmConnectionPool::Dial(g_Websocket.m_Pool, conn->m_Url.m_Hostname, conn->m_Url.m_Port, conn->m_SSL, g_Websocket.m_Timeout, &conn->m_Connection, &sr);
if (dmConnectionPool::RESULT_OK != pool_result)
{
CLOSE_CONN("Failed to open connection: %s", dmSocket::ResultToString(sr));
return;
}
SetState(conn, STATE_HANDSHAKE_WRITE);
}
static dmExtension::Result OnUpdate(dmExtension::Params* params)
{
uint32_t size = g_Websocket.m_Connections.Size();
@ -514,7 +653,7 @@ static dmExtension::Result OnUpdate(dmExtension::Params* params)
--size;
DestroyConnection(conn);
}
else if (STATE_CONNECTED == conn->m_State)
else if ((STATE_CONNECTED == conn->m_State) || (STATE_DISCONNECTING == conn->m_State))
{
#if defined(HAVE_WSLAY)
int r = WSL_Poll(conn->m_Ctx);
@ -523,27 +662,9 @@ static dmExtension::Result OnUpdate(dmExtension::Params* params)
CLOSE_CONN("Websocket closing for %s (%s)", conn->m_Url.m_Hostname, WSL_ResultToString(r));
continue;
}
#else
int recv_bytes = 0;
dmSocket::Result sr = Receive(conn, conn->m_Buffer, conn->m_BufferCapacity-1, &recv_bytes);
if( sr == dmSocket::RESULT_WOULDBLOCK )
{
continue;
}
if (dmSocket::RESULT_OK == sr)
{
PushMessage(conn, MESSAGE_TYPE_NORMAL, recv_bytes, (const uint8_t*)conn->m_Buffer);
}
else
{
CLOSE_CONN("Websocket failed to receive data %s", dmSocket::ResultToString(sr));
continue;
}
#endif
uint32_t offset = 0;
bool close_received = false;
for (uint32_t i = 0; i < conn->m_Messages.Size(); ++i)
{
const Message& msg = conn->m_Messages[i];
@ -551,27 +672,27 @@ static dmExtension::Result OnUpdate(dmExtension::Params* params)
if (EVENT_DISCONNECTED == msg.m_Type)
{
conn->m_Status = RESULT_OK;
CloseConnection(conn);
// Put the message at the front of the buffer
conn->m_Messages.SetSize(0);
conn->m_BufferSize = 0;
PushMessage(conn, MESSAGE_TYPE_CLOSE, msg.m_Length, (const uint8_t*)conn->m_Buffer+offset);
close_received = true;
// close the connection and immediately transition to the DISCONNECTED
// state
SetState(conn, STATE_DISCONNECTED);
conn->m_CloseCode = msg.m_Code;
break;
}
HandleCallback(conn, EVENT_MESSAGE, offset, msg.m_Length);
offset += msg.m_Length;
}
if (!close_received) // saving the close message for next step
{
conn->m_Messages.SetSize(0);
conn->m_BufferSize = 0;
}
}
else if (STATE_HANDSHAKE_READ == conn->m_State)
{
if (CheckConnectTimeout(conn))
{
CLOSE_CONN("Connect sequence timed out");
continue;
}
Result result = ReceiveHeaders(conn);
if (RESULT_WOULDBLOCK == result)
{
@ -605,14 +726,27 @@ static dmExtension::Result OnUpdate(dmExtension::Params* params)
dmSocket::SetReceiveTimeout(conn->m_Socket, 1000);
if (conn->m_SSLSocket)
dmSSLSocket::SetReceiveTimeout(conn->m_SSLSocket, 1000);
#endif
dmSocket::SetBlocking(conn->m_Socket, false);
dmSocket::SetBlocking(conn->m_Socket, false);
#endif
SetState(conn, STATE_CONNECTED);
HandleCallback(conn, EVENT_CONNECTED, 0, 0);
}
else if (STATE_HANDSHAKE_WRITE == conn->m_State)
{
if (CheckConnectTimeout(conn))
{
CLOSE_CONN("Connect sequence timed out");
continue;
}
if (conn->m_ConnectionThread)
{
dmThread::Join(conn->m_ConnectionThread);
conn->m_ConnectionThread = 0;
}
conn->m_Socket = dmConnectionPool::GetSocket(g_Websocket.m_Pool, conn->m_Connection);
conn->m_SSLSocket = dmConnectionPool::GetSSLSocket(g_Websocket.m_Pool, conn->m_Connection);
Result result = SendClientHandshake(conn);
if (RESULT_WOULDBLOCK == result)
{
@ -626,52 +760,67 @@ static dmExtension::Result OnUpdate(dmExtension::Params* params)
SetState(conn, STATE_HANDSHAKE_READ);
}
else if (STATE_CREATE == conn->m_State)
{
if (CheckConnectTimeout(conn))
{
CLOSE_CONN("Connect sequence timed out");
continue;
}
#if defined(__EMSCRIPTEN__)
char uri_buffer[dmURI::MAX_URI_LEN];
const char* uri;
bool no_path = conn->m_Url.m_Path[0] == '\0';
bool no_port = conn->m_Url.m_Port == -1;
if (no_path && no_port)
{
dmSnPrintf(uri_buffer, sizeof(uri_buffer), "%s://%s", conn->m_Url.m_Scheme, conn->m_Url.m_Hostname);
}
else if (no_port)
{
dmSnPrintf(uri_buffer, sizeof(uri_buffer), "%s://%s%s", conn->m_Url.m_Scheme, conn->m_Url.m_Hostname, conn->m_Url.m_Path);
}
else if (no_path)
{
dmSnPrintf(uri_buffer, sizeof(uri_buffer), "%s://%s:%d", conn->m_Url.m_Scheme, conn->m_Url.m_Hostname, conn->m_Url.m_Port);
}
else {
dmSnPrintf(uri_buffer, sizeof(uri_buffer), "%s://%s:%d%s", conn->m_Url.m_Scheme, conn->m_Url.m_Hostname, conn->m_Url.m_Port, conn->m_Url.m_Path);
}
uri = uri_buffer;
EmscriptenWebSocketCreateAttributes ws_attrs = {
uri,
conn->m_Protocol,
EM_TRUE
};
EMSCRIPTEN_WEBSOCKET_T ws = emscripten_websocket_new(&ws_attrs);
if (ws < 0)
{
CLOSE_CONN("Failed to connect to '%s:%d': %d", conn->m_Url.m_Hostname, (int)conn->m_Url.m_Port, ws);
continue;
}
conn->m_WS = ws;
emscripten_websocket_set_onopen_callback(ws, conn, Emscripten_WebSocketOnOpen);
emscripten_websocket_set_onerror_callback(ws, conn, Emscripten_WebSocketOnError);
emscripten_websocket_set_onclose_callback(ws, conn, Emscripten_WebSocketOnClose);
emscripten_websocket_set_onmessage_callback(ws, conn, Emscripten_WebSocketOnMessage);
#else
conn->m_ConnectionThread = dmThread::New((dmThread::ThreadStart)ConnectionWorker, 0x80000, conn, "WSConnect");
#endif
SetState(conn, STATE_CONNECTING);
}
else if (STATE_CONNECTING == conn->m_State)
{
#if defined(__EMSCRIPTEN__)
conn->m_SSLSocket = dmSSLSocket::INVALID_SOCKET_HANDLE;
char uri_buffer[dmURI::MAX_URI_LEN];
const char* uri;
if (conn->m_Url.m_Path[0] != '\0') {
dmSnPrintf(uri_buffer, sizeof(uri_buffer), "%s%s", conn->m_Url.m_Hostname, conn->m_Url.m_Path);
uri = uri_buffer;
} else {
uri = conn->m_Url.m_Hostname;
}
dmSocket::Address address;
dmSocket::Result sr = dmSocket::GetHostByName(uri, &address, true, false);
if (dmSocket::RESULT_OK != sr) {
CLOSE_CONN("Failed to get address from host name '%s': %s", uri, dmSocket::ResultToString(sr));
continue;
}
sr = dmSocket::New(address.m_family, dmSocket::TYPE_STREAM, dmSocket::PROTOCOL_TCP, &conn->m_Socket);
if (dmSocket::RESULT_OK != sr) {
CLOSE_CONN("Failed to create socket for '%s': %s", conn->m_Url.m_Hostname, dmSocket::ResultToString(sr));
continue;
}
sr = dmSocket::Connect(conn->m_Socket, address, conn->m_Url.m_Port);
if (dmSocket::RESULT_OK != sr) {
CLOSE_CONN("Failed to connect to '%s:%d': %s", conn->m_Url.m_Hostname, (int)conn->m_Url.m_Port, dmSocket::ResultToString(sr));
continue;
}
#else
dmSocket::Result sr;
int timeout = g_Websocket.m_Timeout;
dmConnectionPool::Result pool_result = dmConnectionPool::Dial(g_Websocket.m_Pool, conn->m_Url.m_Hostname, conn->m_Url.m_Port, g_Websocket.m_Channel, conn->m_SSL, timeout, &conn->m_Connection, &sr);
if (dmConnectionPool::RESULT_OK != pool_result)
if (CheckConnectTimeout(conn))
{
CLOSE_CONN("Failed to open connection: %s", dmSocket::ResultToString(sr));
CLOSE_CONN("Connect sequence timed out");
continue;
}
conn->m_Socket = dmConnectionPool::GetSocket(g_Websocket.m_Pool, conn->m_Connection);
conn->m_SSLSocket = dmConnectionPool::GetSSLSocket(g_Websocket.m_Pool, conn->m_Connection);
#endif
SetState(conn, STATE_HANDSHAKE_WRITE);
}
}

View File

@ -13,13 +13,17 @@
#if defined(HAVE_WSLAY)
#include <wslay/wslay.h>
#endif
#if defined(__EMSCRIPTEN__)
#include <emscripten/websocket.h>
#endif
#include <dmsdk/dlib/connection_pool.h>
#include <dmsdk/dlib/socket.h>
#include <dmsdk/dlib/dns.h>
#include <dmsdk/dlib/uri.h>
#include <dmsdk/dlib/array.h>
#include <dmsdk/dlib/thread.h>
namespace dmCrypt
{
@ -35,10 +39,12 @@ namespace dmWebsocket
enum State
{
STATE_CREATE,
STATE_CONNECTING,
STATE_HANDSHAKE_WRITE,
STATE_HANDSHAKE_READ,
STATE_CONNECTED,
STATE_DISCONNECTING,
STATE_DISCONNECTED,
};
@ -66,32 +72,69 @@ namespace dmWebsocket
MESSAGE_TYPE_CLOSE = 1,
};
enum DataType
{
DATA_TYPE_BINARY = 0,
DATA_TYPE_TEXT = 1,
};
struct Message
{
uint16_t m_Code;
uint32_t m_Length:30;
uint32_t m_Type:2;
};
struct HttpHeader
{
const char* m_Key;
const char* m_Value;
HttpHeader(const char* key, const char* value);
~HttpHeader();
};
struct HandshakeResponse
{
int m_HttpMajor;
int m_HttpMinor;
int m_ResponseStatusCode;
int m_BodyOffset;
dmArray<HttpHeader*> m_Headers;
~HandshakeResponse();
HttpHeader* GetHeader(const char* header);
};
struct WebsocketConnection
{
dmScript::LuaCallbackInfo* m_Callback;
#if defined(HAVE_WSLAY)
wslay_event_context_ptr m_Ctx;
#endif
#if defined(__EMSCRIPTEN__)
EMSCRIPTEN_WEBSOCKET_T m_WS;
#endif
dmURI::Parts m_Url;
dmConnectionPool::HConnection m_Connection;
dmSocket::Socket m_Socket;
dmSSLSocket::Socket m_SSLSocket;
dmThread::Thread m_ConnectionThread;
dmArray<Message> m_Messages; // lengths of the messages in the data buffer
uint64_t m_ConnectTimeout;
uint8_t m_Key[16];
const char* m_Protocol;
const char* m_CustomHeaders;
State m_State;
char* m_Buffer;
int m_BufferSize;
uint32_t m_BufferCapacity;
Result m_Status;
uint16_t m_CloseCode;
uint8_t m_SSL:1;
uint8_t m_HasHandshakeData:1;
uint8_t :6;
uint8_t :7;
HandshakeResponse* m_HandshakeResponse;
};
// Set error message
@ -101,6 +144,9 @@ namespace dmWebsocket
Result SetStatus(WebsocketConnection* conn, Result status, const char* fmt, ...);
#endif
// Set socket state
void SetState(WebsocketConnection* conn, State state);
// Communication
dmSocket::Result Send(WebsocketConnection* conn, const char* buffer, int length, int* out_sent_bytes);
dmSocket::Result Receive(WebsocketConnection* conn, void* buffer, int length, int* received_bytes);
@ -111,8 +157,11 @@ namespace dmWebsocket
Result ReceiveHeaders(WebsocketConnection* conn);
Result VerifyHeaders(WebsocketConnection* conn);
// Callback to Lua
void HandleCallback(WebsocketConnection* conn, int event, int msg_offset, int msg_length);
// Messages
Result PushMessage(WebsocketConnection* conn, MessageType type, int length, const uint8_t* msg);
Result PushMessage(WebsocketConnection* conn, MessageType type, int length, const uint8_t* msg, uint16_t code);
#if defined(HAVE_WSLAY)
// Wslay callbacks
@ -126,6 +175,12 @@ namespace dmWebsocket
int WSL_GenmaskCallback(wslay_event_context_ptr ctx, uint8_t *buf, size_t len, void *user_data);
const char* WSL_ResultToString(int err);
#endif
#if defined(__EMSCRIPTEN__)
EM_BOOL Emscripten_WebSocketOnOpen(int eventType, const EmscriptenWebSocketOpenEvent *websocketEvent, void *userData);
EM_BOOL Emscripten_WebSocketOnError(int eventType, const EmscriptenWebSocketErrorEvent *websocketEvent, void *userData);
EM_BOOL Emscripten_WebSocketOnClose(int eventType, const EmscriptenWebSocketCloseEvent *websocketEvent, void *userData);
EM_BOOL Emscripten_WebSocketOnMessage(int eventType, const EmscriptenWebSocketMessageEvent *websocketEvent, void *userData);
#endif
// Random numbers (PCG)
typedef struct { uint64_t state; uint64_t inc; } pcg32_random_t;
@ -138,17 +193,5 @@ namespace dmWebsocket
#else
void DebugLog(int level, const char* fmt, ...);
#endif
void DebugPrint(int level, const char* msg, const void* _bytes, uint32_t num_bytes);
}

View File

@ -39,11 +39,7 @@ const char* WSL_ResultToString(int err)
int WSL_Init(wslay_event_context_ptr* ctx, ssize_t buffer_size, void* userctx)
{
// Currently only supports client implementation
int ret = -1;
ret = wslay_event_context_client_init(ctx, &g_WslCallbacks, userctx);
if (ret == 0)
wslay_event_config_set_max_recv_msg_length(*ctx, buffer_size);
return ret;
return wslay_event_context_client_init(ctx, &g_WslCallbacks, userctx);
}
@ -124,7 +120,7 @@ void WSL_OnMsgRecvCallback(wslay_event_context_ptr ctx, const struct wslay_event
WebsocketConnection* conn = (WebsocketConnection*)user_data;
if (arg->opcode == WSLAY_TEXT_FRAME || arg->opcode == WSLAY_BINARY_FRAME)
{
PushMessage(conn, MESSAGE_TYPE_NORMAL, arg->msg_length, arg->msg);
PushMessage(conn, MESSAGE_TYPE_NORMAL, arg->msg_length, arg->msg, 0);
} else if (arg->opcode == WSLAY_CONNECTION_CLOSE)
{
// The first two bytes is the close code
@ -137,8 +133,9 @@ void WSL_OnMsgRecvCallback(wslay_event_context_ptr ctx, const struct wslay_event
}
char buffer[1024];
len = dmSnPrintf(buffer, sizeof(buffer), "Server closing (%u). Reason: '%s'", wslay_event_get_status_code_received(ctx), reason);
PushMessage(conn, MESSAGE_TYPE_CLOSE, len, (const uint8_t*)buffer);
uint16_t status_code = wslay_event_get_status_code_received(ctx);
len = dmSnPrintf(buffer, sizeof(buffer), "Server closing (%u). Reason: '%s'", status_code, reason);
PushMessage(conn, MESSAGE_TYPE_CLOSE, len, (const uint8_t*)buffer, status_code);
if (!wslay_event_get_close_sent(ctx))
{