mirror of
https://github.com/defold/extension-websocket.git
synced 2025-09-30 09:12:18 +02:00
Compare commits
35 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
39abd7cdea | ||
|
f988413a74 | ||
|
73b236b249 | ||
|
636a11daa3 | ||
|
0f147ef180 | ||
|
3cd0328c2a | ||
|
f5aa57452f | ||
|
7e89b8a685 | ||
|
ba7454a431 | ||
|
b93a91c9b8 | ||
|
0bf63cbdf8 | ||
|
8a9dc759a4 | ||
|
70afde4cfa | ||
|
ed6d131470 | ||
|
2c9c0b74f1 | ||
|
8450a88640 | ||
|
3636ea73db | ||
|
1cc1d802b3 | ||
|
94bcc82f25 | ||
|
d62a53cbcc | ||
|
ea2fe97943 | ||
|
268e9bf472 | ||
|
5ee358cbba | ||
|
78d527d3a8 | ||
|
b54e3e07ad | ||
|
e105702c79 | ||
|
9d1ace0a82 | ||
|
833477a134 | ||
|
15a589585a | ||
|
3fe8fbc0ff | ||
|
ba2b8e4a69 | ||
|
176f213060 | ||
|
dc1d57d661 | ||
|
5b0a9960a8 | ||
|
40ba1b334c |
76
.github/workflows/bob.yml
vendored
Normal file
76
.github/workflows/bob.yml
vendored
Normal 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
|
5
.github/workflows/trigger-site-rebuild.yml
vendored
5
.github/workflows/trigger-site-rebuild.yml
vendored
@@ -1,6 +1,9 @@
|
|||||||
name: Trigger site rebuild
|
name: Trigger site rebuild
|
||||||
|
|
||||||
on: [push]
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- 'master'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
site-rebuild:
|
site-rebuild:
|
||||||
|
30
README.md
30
README.md
@@ -1,5 +1,9 @@
|
|||||||
|
|
||||||
|
|
||||||
# Defold websocket extension
|
# Defold websocket extension
|
||||||
|
|
||||||
|
[](https://github.com/defold/extension-websocket/actions)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
To use this library in your Defold project, add the following URL to your `game.project` dependencies:
|
To use this library in your Defold project, add the following URL to your `game.project` dependencies:
|
||||||
|
|
||||||
@@ -20,3 +24,29 @@ Set it to:
|
|||||||
* `0` to disable debugging (i.e. no debug output).
|
* `0` to disable debugging (i.e. no debug output).
|
||||||
* `1` to display state changes.
|
* `1` to display state changes.
|
||||||
* `2` to display the messages sent and received.
|
* `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
|
||||||
|
@@ -14,18 +14,16 @@ Here is how you connect to a websocket and listen to events:
|
|||||||
```lua
|
```lua
|
||||||
local function websocket_callback(self, conn, data)
|
local function websocket_callback(self, conn, data)
|
||||||
if data.event == websocket.EVENT_DISCONNECTED then
|
if data.event == websocket.EVENT_DISCONNECTED then
|
||||||
print("disconnected " .. conn)
|
log("Disconnected: " .. tostring(conn))
|
||||||
self.connection = nil
|
self.connection = nil
|
||||||
|
update_gui(self)
|
||||||
elseif data.event == websocket.EVENT_CONNECTED then
|
elseif data.event == websocket.EVENT_CONNECTED then
|
||||||
print("Connected " .. conn)
|
update_gui(self)
|
||||||
-- self.connection = conn
|
log("Connected: " .. tostring(conn))
|
||||||
elseif data.event == websocket.EVENT_ERROR then
|
elseif data.event == websocket.EVENT_ERROR then
|
||||||
print("Error:", data.message)
|
log("Error: '" .. data.error .. "'")
|
||||||
elseif data.event == websocket.EVENT_MESSAGE then
|
elseif data.event == websocket.EVENT_MESSAGE then
|
||||||
print("Receiving: '" .. tostring(data.message) .. "'")
|
log("Receiving: '" .. tostring(data.message) .. "'")
|
||||||
end
|
|
||||||
elseif data.event == websocket.EVENT_DISCONNECTED then
|
|
||||||
print("Disconnected: '" .. tostring(data.message) .. "'")
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@@ -73,7 +73,7 @@ local function websocket_callback(self, conn, data)
|
|||||||
update_gui(self)
|
update_gui(self)
|
||||||
log("Connected: " .. tostring(conn))
|
log("Connected: " .. tostring(conn))
|
||||||
elseif data.event == websocket.EVENT_ERROR then
|
elseif data.event == websocket.EVENT_ERROR then
|
||||||
log("Error: '" .. data.error .. "'")
|
log("Error: '" .. tostring(data.error) .. "'")
|
||||||
elseif data.event == websocket.EVENT_MESSAGE then
|
elseif data.event == websocket.EVENT_MESSAGE then
|
||||||
log("Receiving: '" .. tostring(data.message) .. "'")
|
log("Receiving: '" .. tostring(data.message) .. "'")
|
||||||
end
|
end
|
||||||
|
@@ -17,6 +17,17 @@
|
|||||||
type: table
|
type: table
|
||||||
desc: optional parameters as properties. The following parameters can be set
|
desc: optional parameters as properties. The following parameters can be set
|
||||||
members:
|
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
|
- name: callback
|
||||||
type: function
|
type: function
|
||||||
@@ -48,11 +59,7 @@
|
|||||||
|
|
||||||
- name: message
|
- name: message
|
||||||
type: string
|
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`
|
|
||||||
|
|
||||||
|
|
||||||
returns:
|
returns:
|
||||||
@@ -65,21 +72,25 @@
|
|||||||
```lua
|
```lua
|
||||||
local function websocket_callback(self, conn, data)
|
local function websocket_callback(self, conn, data)
|
||||||
if data.event == websocket.EVENT_DISCONNECTED then
|
if data.event == websocket.EVENT_DISCONNECTED then
|
||||||
print("disconnected " .. conn)
|
log("Disconnected: " .. tostring(conn))
|
||||||
self.connection = nil
|
self.connection = nil
|
||||||
|
update_gui(self)
|
||||||
elseif data.event == websocket.EVENT_CONNECTED then
|
elseif data.event == websocket.EVENT_CONNECTED then
|
||||||
print("Connected " .. conn)
|
update_gui(self)
|
||||||
-- self.connection = conn
|
log("Connected: " .. tostring(conn))
|
||||||
elseif data.event == websocket.EVENT_ERROR then
|
elseif data.event == websocket.EVENT_ERROR then
|
||||||
print("Error:", data.error)
|
log("Error: '" .. data.message .. "'")
|
||||||
elseif data.event == websocket.EVENT_MESSAGE then
|
elseif data.event == websocket.EVENT_MESSAGE then
|
||||||
print("Receiving: '" .. tostring(data.message) .. "'")
|
log("Receiving: '" .. tostring(data.message) .. "'")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
function init(self)
|
function init(self)
|
||||||
self.url = "ws://echo.websocket.org"
|
self.url = "ws://echo.websocket.org"
|
||||||
local params = {}
|
local params = {
|
||||||
|
timeout = 3000,
|
||||||
|
headers = "Sec-WebSocket-Protocol: chat\r\nOrigin: mydomain.com\r\n"
|
||||||
|
}
|
||||||
self.connection = websocket.connect(self.url, params, websocket_callback)
|
self.connection = websocket.connect(self.url, params, websocket_callback)
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -112,6 +123,17 @@
|
|||||||
- name: message
|
- name: message
|
||||||
type: string
|
type: string
|
||||||
desc: the message to send
|
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:
|
examples:
|
||||||
- desc: |-
|
- desc: |-
|
||||||
|
@@ -1,5 +1,6 @@
|
|||||||
#include "websocket.h"
|
#include "websocket.h"
|
||||||
#include <dmsdk/dlib/socket.h>
|
#include <dmsdk/dlib/socket.h>
|
||||||
|
#include <ctype.h> // tolower
|
||||||
|
|
||||||
namespace dmWebsocket
|
namespace dmWebsocket
|
||||||
{
|
{
|
||||||
@@ -39,8 +40,12 @@ static Result SendClientHandshakeHeaders(WebsocketConnection* conn)
|
|||||||
dmSnPrintf(port, sizeof(port), ":%d", conn->m_Url.m_Port);
|
dmSnPrintf(port, sizeof(port), ":%d", conn->m_Url.m_Port);
|
||||||
|
|
||||||
dmSocket::Result sr;
|
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(conn->m_Url.m_Path);
|
||||||
|
}
|
||||||
WS_SENDALL(" HTTP/1.1\r\n");
|
WS_SENDALL(" HTTP/1.1\r\n");
|
||||||
WS_SENDALL("Host: ");
|
WS_SENDALL("Host: ");
|
||||||
WS_SENDALL(conn->m_Url.m_Hostname);
|
WS_SENDALL(conn->m_Url.m_Hostname);
|
||||||
@@ -53,9 +58,23 @@ static Result SendClientHandshakeHeaders(WebsocketConnection* conn)
|
|||||||
WS_SENDALL("\r\n");
|
WS_SENDALL("\r\n");
|
||||||
WS_SENDALL("Sec-WebSocket-Version: 13\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");
|
WS_SENDALL("\r\n");
|
||||||
|
|
||||||
@@ -100,17 +119,12 @@ Result ReceiveHeaders(WebsocketConnection* conn)
|
|||||||
#else
|
#else
|
||||||
Result ReceiveHeaders(WebsocketConnection* conn)
|
Result ReceiveHeaders(WebsocketConnection* conn)
|
||||||
{
|
{
|
||||||
dmSocket::Selector selector;
|
dmSocket::Result sr = WaitForSocket(conn, dmSocket::SELECTOR_KIND_READ, SOCKET_WAIT_TIMEOUT);
|
||||||
dmSocket::SelectorZero(&selector);
|
|
||||||
dmSocket::SelectorSet(&selector, dmSocket::SELECTOR_KIND_READ, conn->m_Socket);
|
|
||||||
|
|
||||||
dmSocket::Result sr = dmSocket::Select(&selector, 200*1000);
|
|
||||||
|
|
||||||
if (dmSocket::RESULT_OK != sr)
|
if (dmSocket::RESULT_OK != sr)
|
||||||
{
|
{
|
||||||
if (dmSocket::RESULT_WOULDBLOCK)
|
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;
|
return RESULT_WOULDBLOCK;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -156,6 +170,20 @@ Result ReceiveHeaders(WebsocketConnection* conn)
|
|||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
static int dmStriCmp(const char* s1, const char* s2)
|
||||||
|
{
|
||||||
|
for (;;)
|
||||||
|
{
|
||||||
|
if (!*s1 || !*s2 || tolower((unsigned char) *s1) != tolower((unsigned char) *s2))
|
||||||
|
{
|
||||||
|
return (unsigned char) *s1 - (unsigned char) *s2;
|
||||||
|
}
|
||||||
|
s1++;
|
||||||
|
s2++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
#if defined(__EMSCRIPTEN__)
|
#if defined(__EMSCRIPTEN__)
|
||||||
Result VerifyHeaders(WebsocketConnection* conn)
|
Result VerifyHeaders(WebsocketConnection* conn)
|
||||||
{
|
{
|
||||||
@@ -176,11 +204,9 @@ Result VerifyHeaders(WebsocketConnection* conn)
|
|||||||
|
|
||||||
r = strstr(r, "\r\n") + 2;
|
r = strstr(r, "\r\n") + 2;
|
||||||
|
|
||||||
bool upgraded = false;
|
bool connection = false;
|
||||||
|
bool upgrade = false;
|
||||||
bool valid_key = false;
|
bool valid_key = false;
|
||||||
const char* protocol = "";
|
|
||||||
|
|
||||||
// TODO: Perhaps also support the Sec-WebSocket-Protocol
|
|
||||||
|
|
||||||
// parse the headers in place
|
// parse the headers in place
|
||||||
while (r < endtag)
|
while (r < endtag)
|
||||||
@@ -197,27 +223,39 @@ Result VerifyHeaders(WebsocketConnection* conn)
|
|||||||
*r = 0;
|
*r = 0;
|
||||||
r += 2;
|
r += 2;
|
||||||
|
|
||||||
if (strcmp(key, "Connection") == 0 && strcmp(value, "Upgrade") == 0)
|
// Page 18 in https://tools.ietf.org/html/rfc6455#section-11.3.3
|
||||||
upgraded = true;
|
if (dmStriCmp(key, "Connection") == 0 && dmStriCmp(value, "Upgrade") == 0)
|
||||||
else if (strcmp(key, "Sec-WebSocket-Accept") == 0)
|
connection = true;
|
||||||
|
else if (dmStriCmp(key, "Upgrade") == 0 && dmStriCmp(value, "websocket") == 0)
|
||||||
|
upgrade = true;
|
||||||
|
else if (dmStriCmp(key, "Sec-WebSocket-Accept") == 0)
|
||||||
{
|
{
|
||||||
|
|
||||||
uint8_t client_key[32 + 40];
|
uint8_t client_key[32 + 40];
|
||||||
uint32_t client_key_len = sizeof(client_key);
|
uint32_t client_key_len = sizeof(client_key);
|
||||||
dmCrypt::Base64Encode(conn->m_Key, sizeof(conn->m_Key), client_key, &client_key_len);
|
dmCrypt::Base64Encode(conn->m_Key, sizeof(conn->m_Key), client_key, &client_key_len);
|
||||||
client_key[client_key_len] = 0;
|
client_key[client_key_len] = 0;
|
||||||
|
|
||||||
|
DebugLog(2, "Secret key (base64): %s", client_key);
|
||||||
|
|
||||||
memcpy(client_key + client_key_len, RFC_MAGIC, strlen(RFC_MAGIC));
|
memcpy(client_key + client_key_len, RFC_MAGIC, strlen(RFC_MAGIC));
|
||||||
client_key_len += strlen(RFC_MAGIC);
|
client_key_len += strlen(RFC_MAGIC);
|
||||||
client_key[client_key_len] = 0;
|
client_key[client_key_len] = 0;
|
||||||
|
|
||||||
|
DebugLog(2, "Secret key + RFC_MAGIC: %s", client_key);
|
||||||
|
|
||||||
uint8_t client_key_sha1[20];
|
uint8_t client_key_sha1[20];
|
||||||
dmCrypt::HashSha1(client_key, client_key_len, client_key_sha1);
|
dmCrypt::HashSha1(client_key, client_key_len, client_key_sha1);
|
||||||
|
|
||||||
|
DebugPrint(2, "Hashed key (sha1):", client_key_sha1, sizeof(client_key_sha1));
|
||||||
|
|
||||||
client_key_len = sizeof(client_key);
|
client_key_len = sizeof(client_key);
|
||||||
dmCrypt::Base64Encode(client_key_sha1, sizeof(client_key_sha1), client_key, &client_key_len);
|
dmCrypt::Base64Encode(client_key_sha1, sizeof(client_key_sha1), client_key, &client_key_len);
|
||||||
client_key[client_key_len] = 0;
|
client_key[client_key_len] = 0;
|
||||||
|
|
||||||
|
DebugLog(2, "Client key (base64): %s", client_key);
|
||||||
|
|
||||||
|
DebugLog(2, "Server key (base64): %s", value);
|
||||||
|
|
||||||
if (strcmp(value, (const char*)client_key) == 0)
|
if (strcmp(value, (const char*)client_key) == 0)
|
||||||
valid_key = true;
|
valid_key = true;
|
||||||
}
|
}
|
||||||
@@ -231,16 +269,19 @@ Result VerifyHeaders(WebsocketConnection* conn)
|
|||||||
conn->m_Buffer[size] = 0;
|
conn->m_Buffer[size] = 0;
|
||||||
conn->m_HasHandshakeData = conn->m_BufferSize != 0 ? 1 : 0;
|
conn->m_HasHandshakeData = conn->m_BufferSize != 0 ? 1 : 0;
|
||||||
|
|
||||||
if (!upgraded)
|
if (!connection)
|
||||||
|
dmLogError("Failed to find the Connection keyword in the response headers");
|
||||||
|
if (!upgrade)
|
||||||
dmLogError("Failed to find the Upgrade keyword in the response headers");
|
dmLogError("Failed to find the Upgrade keyword in the response headers");
|
||||||
if (!valid_key)
|
if (!valid_key)
|
||||||
dmLogError("Failed to find valid key in the response headers");
|
dmLogError("Failed to find valid key in the response headers");
|
||||||
|
|
||||||
if (!(upgraded && valid_key)) {
|
bool ok = connection && upgrade && valid_key;
|
||||||
|
if (!ok) {
|
||||||
dmLogError("Response:\n\"%s\"\n", conn->m_Buffer);
|
dmLogError("Response:\n\"%s\"\n", conn->m_Buffer);
|
||||||
}
|
}
|
||||||
|
|
||||||
return (upgraded && valid_key) ? RESULT_OK : RESULT_HANDSHAKE_FAILED;
|
return ok ? RESULT_OK : RESULT_HANDSHAKE_FAILED;
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
@@ -1,8 +1,8 @@
|
|||||||
#include "script_util.h"
|
#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;
|
bool b = false;
|
||||||
if (lua_isboolean(L, numArg))
|
if (lua_isboolean(L, numArg))
|
||||||
@@ -16,17 +16,17 @@ bool luaL_checkbool(lua_State *L, int numArg)
|
|||||||
return b;
|
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);
|
int type = lua_type(L, numArg);
|
||||||
if (type != LUA_TNONE && type != LUA_TNIL)
|
if (type != LUA_TNONE && type != LUA_TNIL)
|
||||||
{
|
{
|
||||||
return luaL_checkbool(L, numArg);
|
return CheckBool(L, numArg);
|
||||||
}
|
}
|
||||||
return def;
|
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);
|
int type = lua_type(L, numArg);
|
||||||
if (type != LUA_TNONE && type != LUA_TNIL)
|
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;
|
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);
|
int type = lua_type(L, numArg);
|
||||||
if (type != LUA_TNONE && type != LUA_TNIL)
|
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;
|
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;
|
lua_Number result = def;
|
||||||
if(lua_istable(L, numArg))
|
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;
|
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;
|
char* result = def;
|
||||||
if(lua_istable(L, numArg))
|
if(lua_istable(L, numArg))
|
||||||
|
@@ -2,11 +2,11 @@
|
|||||||
|
|
||||||
#include <dmsdk/sdk.h>
|
#include <dmsdk/sdk.h>
|
||||||
|
|
||||||
namespace dmWebsocket {
|
namespace dmScript {
|
||||||
bool luaL_checkbool(lua_State *L, int numArg);
|
bool CheckBool(lua_State *L, int numArg);
|
||||||
bool luaL_checkboold(lua_State *L, int numArg, int def);
|
bool CheckBoold(lua_State *L, int numArg, int def);
|
||||||
lua_Number luaL_checknumberd(lua_State *L, int numArg, lua_Number def);
|
lua_Number CheckNumberd(lua_State *L, int numArg, lua_Number def);
|
||||||
char* luaL_checkstringd(lua_State *L, int numArg, const char* def);
|
char* 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);
|
lua_Number CheckTableNumber(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);
|
char* CheckTableString(lua_State *L, int numArg, const char* field, char* def);
|
||||||
} // namespace
|
} // namespace
|
@@ -87,23 +87,50 @@ void DebugPrint(int level, const char* msg, const void* _bytes, uint32_t num_byt
|
|||||||
if (level > g_DebugWebSocket)
|
if (level > g_DebugWebSocket)
|
||||||
return;
|
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;
|
const uint8_t* bytes = (const uint8_t*)_bytes;
|
||||||
printf("%s '", msg);
|
|
||||||
for (uint32_t i = 0; i < num_bytes; ++i)
|
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];
|
int c = bytes[i];
|
||||||
if (isprint(c))
|
if (isprint(c))
|
||||||
printf("%c", c);
|
sublength = dmSnPrintf(submessage, sizeof(submessage), "%c", c);
|
||||||
else if (c == '\r')
|
else if (c == '\r')
|
||||||
printf("\\r");
|
sublength = dmSnPrintf(submessage, sizeof(submessage), "\\r");
|
||||||
else if (c == '\n')
|
else if (c == '\n')
|
||||||
printf("\\n");
|
sublength = dmSnPrintf(submessage, sizeof(submessage), "\\n");
|
||||||
else if (c == '\t')
|
else if (c == '\t')
|
||||||
printf("\\t");
|
sublength = dmSnPrintf(submessage, sizeof(submessage), "\\t");
|
||||||
else
|
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);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -151,6 +178,7 @@ static WebsocketConnection* CreateConnection(const char* url)
|
|||||||
conn->m_Buffer = (char*)malloc(conn->m_BufferCapacity);
|
conn->m_Buffer = (char*)malloc(conn->m_BufferCapacity);
|
||||||
conn->m_Buffer[0] = 0;
|
conn->m_Buffer[0] = 0;
|
||||||
conn->m_BufferSize = 0;
|
conn->m_BufferSize = 0;
|
||||||
|
conn->m_ConnectTimeout = 0;
|
||||||
|
|
||||||
dmURI::Parts uri;
|
dmURI::Parts uri;
|
||||||
dmURI::Parse(url, &conn->m_Url);
|
dmURI::Parse(url, &conn->m_Url);
|
||||||
@@ -182,6 +210,9 @@ static void DestroyConnection(WebsocketConnection* conn)
|
|||||||
WSL_Exit(conn->m_Ctx);
|
WSL_Exit(conn->m_Ctx);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
free((void*)conn->m_CustomHeaders);
|
||||||
|
free((void*)conn->m_Protocol);
|
||||||
|
|
||||||
if (conn->m_Callback)
|
if (conn->m_Callback)
|
||||||
dmScript::DestroyCallback(conn->m_Callback);
|
dmScript::DestroyCallback(conn->m_Callback);
|
||||||
|
|
||||||
@@ -199,6 +230,7 @@ static void DestroyConnection(WebsocketConnection* conn)
|
|||||||
|
|
||||||
free((void*)conn->m_Buffer);
|
free((void*)conn->m_Buffer);
|
||||||
delete conn;
|
delete conn;
|
||||||
|
DebugLog(2, "DestroyConnection: %p", conn);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -237,13 +269,22 @@ static int LuaConnect(lua_State* L)
|
|||||||
return DM_LUA_ERROR("The web socket module isn't initialized");
|
return DM_LUA_ERROR("The web socket module isn't initialized");
|
||||||
|
|
||||||
const char* url = luaL_checkstring(L, 1);
|
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);
|
if (custom_headers != 0)
|
||||||
// long progressValue = luaL_checktable_number(L, 2, "progressValue", -1);
|
{
|
||||||
// char *description = luaL_checktable_string(L, 2, "description", NULL);
|
if (strstr(custom_headers, "\r\n\r\n") != 0)
|
||||||
// char *coverImage = luaL_checktable_string(L, 2, "coverImage", NULL);
|
{
|
||||||
|
return DM_LUA_ERROR("The header field must not contain double '\\r\\n\\r\\n': '%s'", custom_headers);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
WebsocketConnection* conn = CreateConnection(url);
|
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);
|
conn->m_Callback = dmScript::CreateCallback(L, 3);
|
||||||
|
|
||||||
@@ -298,7 +339,7 @@ static int LuaSend(lua_State* L)
|
|||||||
const char* string = luaL_checklstring(L, 2, &string_length);
|
const char* string = luaL_checklstring(L, 2, &string_length);
|
||||||
|
|
||||||
#if defined(HAVE_WSLAY)
|
#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;
|
struct wslay_event_msg msg;
|
||||||
msg.opcode = write_mode;
|
msg.opcode = write_mode;
|
||||||
@@ -376,6 +417,16 @@ static void LuaInit(lua_State* L)
|
|||||||
SETCONSTANT(EVENT_MESSAGE);
|
SETCONSTANT(EVENT_MESSAGE);
|
||||||
SETCONSTANT(EVENT_ERROR);
|
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
|
#undef SETCONSTANT
|
||||||
|
|
||||||
lua_pop(L, 1);
|
lua_pop(L, 1);
|
||||||
@@ -457,6 +508,12 @@ static dmExtension::Result AppFinalize(dmExtension::AppParams* params)
|
|||||||
|
|
||||||
static dmExtension::Result Finalize(dmExtension::Params* params)
|
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;
|
return dmExtension::RESULT_OK;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -491,6 +548,13 @@ Result PushMessage(WebsocketConnection* conn, MessageType type, int length, cons
|
|||||||
return dmWebsocket::RESULT_OK;
|
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 dmExtension::Result OnUpdate(dmExtension::Params* params)
|
static dmExtension::Result OnUpdate(dmExtension::Params* params)
|
||||||
{
|
{
|
||||||
uint32_t size = g_Websocket.m_Connections.Size();
|
uint32_t size = g_Websocket.m_Connections.Size();
|
||||||
@@ -572,6 +636,12 @@ static dmExtension::Result OnUpdate(dmExtension::Params* params)
|
|||||||
}
|
}
|
||||||
else if (STATE_HANDSHAKE_READ == conn->m_State)
|
else if (STATE_HANDSHAKE_READ == conn->m_State)
|
||||||
{
|
{
|
||||||
|
if (CheckConnectTimeout(conn))
|
||||||
|
{
|
||||||
|
CLOSE_CONN("Connect sequence timed out");
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
Result result = ReceiveHeaders(conn);
|
Result result = ReceiveHeaders(conn);
|
||||||
if (RESULT_WOULDBLOCK == result)
|
if (RESULT_WOULDBLOCK == result)
|
||||||
{
|
{
|
||||||
@@ -613,6 +683,12 @@ static dmExtension::Result OnUpdate(dmExtension::Params* params)
|
|||||||
}
|
}
|
||||||
else if (STATE_HANDSHAKE_WRITE == conn->m_State)
|
else if (STATE_HANDSHAKE_WRITE == conn->m_State)
|
||||||
{
|
{
|
||||||
|
if (CheckConnectTimeout(conn))
|
||||||
|
{
|
||||||
|
CLOSE_CONN("Connect sequence timed out");
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
Result result = SendClientHandshake(conn);
|
Result result = SendClientHandshake(conn);
|
||||||
if (RESULT_WOULDBLOCK == result)
|
if (RESULT_WOULDBLOCK == result)
|
||||||
{
|
{
|
||||||
@@ -628,9 +704,20 @@ static dmExtension::Result OnUpdate(dmExtension::Params* params)
|
|||||||
}
|
}
|
||||||
else if (STATE_CONNECTING == conn->m_State)
|
else if (STATE_CONNECTING == conn->m_State)
|
||||||
{
|
{
|
||||||
|
if (CheckConnectTimeout(conn))
|
||||||
|
{
|
||||||
|
CLOSE_CONN("Connect sequence timed out");
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
#if defined(__EMSCRIPTEN__)
|
#if defined(__EMSCRIPTEN__)
|
||||||
conn->m_SSLSocket = dmSSLSocket::INVALID_SOCKET_HANDLE;
|
conn->m_SSLSocket = dmSSLSocket::INVALID_SOCKET_HANDLE;
|
||||||
|
|
||||||
|
EM_ASM({
|
||||||
|
// https://emscripten.org/docs/porting/networking.html#emulated-posix-tcp-sockets-over-websockets
|
||||||
|
Module["websocket"]["subprotocol"] = $0 ? UTF8ToString($0) : null;
|
||||||
|
}, conn->m_Protocol);
|
||||||
|
|
||||||
char uri_buffer[dmURI::MAX_URI_LEN];
|
char uri_buffer[dmURI::MAX_URI_LEN];
|
||||||
const char* uri;
|
const char* uri;
|
||||||
if (conn->m_Url.m_Path[0] != '\0') {
|
if (conn->m_Url.m_Path[0] != '\0') {
|
||||||
|
@@ -66,6 +66,12 @@ namespace dmWebsocket
|
|||||||
MESSAGE_TYPE_CLOSE = 1,
|
MESSAGE_TYPE_CLOSE = 1,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
enum DataType
|
||||||
|
{
|
||||||
|
DATA_TYPE_BINARY = 0,
|
||||||
|
DATA_TYPE_TEXT = 1,
|
||||||
|
};
|
||||||
|
|
||||||
struct Message
|
struct Message
|
||||||
{
|
{
|
||||||
uint32_t m_Length:30;
|
uint32_t m_Length:30;
|
||||||
@@ -83,7 +89,10 @@ namespace dmWebsocket
|
|||||||
dmSocket::Socket m_Socket;
|
dmSocket::Socket m_Socket;
|
||||||
dmSSLSocket::Socket m_SSLSocket;
|
dmSSLSocket::Socket m_SSLSocket;
|
||||||
dmArray<Message> m_Messages; // lengths of the messages in the data buffer
|
dmArray<Message> m_Messages; // lengths of the messages in the data buffer
|
||||||
|
uint64_t m_ConnectTimeout;
|
||||||
uint8_t m_Key[16];
|
uint8_t m_Key[16];
|
||||||
|
const char* m_Protocol;
|
||||||
|
const char* m_CustomHeaders;
|
||||||
State m_State;
|
State m_State;
|
||||||
char* m_Buffer;
|
char* m_Buffer;
|
||||||
int m_BufferSize;
|
int m_BufferSize;
|
||||||
@@ -91,7 +100,7 @@ namespace dmWebsocket
|
|||||||
Result m_Status;
|
Result m_Status;
|
||||||
uint8_t m_SSL:1;
|
uint8_t m_SSL:1;
|
||||||
uint8_t m_HasHandshakeData:1;
|
uint8_t m_HasHandshakeData:1;
|
||||||
uint8_t :6;
|
uint8_t :7;
|
||||||
};
|
};
|
||||||
|
|
||||||
// Set error message
|
// Set error message
|
||||||
|
Reference in New Issue
Block a user