1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/*
* Copyright (C) 2024 Igalia S.L.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS 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 APPLE INC. OR ITS 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.
*/
#pragma once
#include "CommandResult.h"
#include "HTTPServer.h"
#include <map>
#include <optional>
#include <vector>
#include <wtf/HashMap.h>
#include <wtf/JSONValues.h>
#include <wtf/RefCountedAndCanMakeWeakPtr.h>
#include <wtf/Vector.h>
#include <wtf/WeakPtr.h>
#include <wtf/text/WTFString.h>
#if USE(SOUP)
#include <wtf/glib/GRefPtr.h>
typedef struct _SoupServer SoupServer;
typedef struct _SoupWebsocketConnection SoupWebsocketConnection;
#endif
namespace WebDriver {
class Session;
class WebDriverService;
struct Command {
// Defined as js-uint, but in practice opaque for the remote end.
String id;
String method;
RefPtr<JSON::Object> parameters;
static std::optional<Command> fromData(const char* data, size_t dataLength);
};
// https://w3c.github.io/webdriver-bidi/#websocket-listener
// A WebSocket listener is a network endpoint that is able to accept incoming WebSocket connections.
struct WebSocketListener : public RefCounted<WebSocketListener> {
static RefPtr<WebSocketListener> create(const String& host, unsigned port, bool secure, const std::vector<String>& resources = { })
{
return adoptRef(*new WebSocketListener(host, port, secure, resources));
}
String host;
unsigned port { 0 };
bool isSecure { false };
std::vector<String> resources { };
private:
WebSocketListener(const String& host, unsigned port, bool isSecure, const std::vector<String>& resources)
: host(host)
, port(port)
, isSecure(isSecure)
, resources(resources)
{
}
};
class WebSocketMessageHandler {
public:
#if USE(SOUP)
using Connection = GRefPtr<SoupWebsocketConnection>;
#endif
struct Message {
// Optional connection, as the message might be generated without a connection object available (e.g. inside a method handler).
// In this case, it gets associated to the connection when sending the message back to the client.
Connection connection;
const CString payload;
static Message fail(CommandResult::ErrorCode, std::optional<Connection>, std::optional<String> errorMessage = std::nullopt, std::optional<int> commandId = std::nullopt);
static Message reply(const String& type, unsigned id, Ref<JSON::Value>&& result);
};
virtual bool acceptHandshake(HTTPRequestHandler::Request&&) = 0;
virtual void handleMessage(Message&&, Function<void(Message&&)>&& replyHandler) = 0;
virtual void clientDisconnected(const Connection&) = 0;
private:
};
class WebSocketServer : public RefCountedAndCanMakeWeakPtr<WebSocketServer> {
public:
explicit WebSocketServer(WebSocketMessageHandler&, WebDriverService&);
virtual ~WebSocketServer() = default;
std::optional<String> listen(const String& host, unsigned port);
void disconnect();
WebSocketMessageHandler& messageHandler() { return m_messageHandler; }
const RefPtr<WebSocketListener>& listener() const { return m_listener; }
void addStaticConnection(WebSocketMessageHandler::Connection&&);
bool isStaticConnection(const WebSocketMessageHandler::Connection&);
void removeStaticConnection(const WebSocketMessageHandler::Connection&);
void addConnection(WebSocketMessageHandler::Connection&&, const String& sessionId);
RefPtr<Session> session(const WebSocketMessageHandler::Connection&);
std::optional<WebSocketMessageHandler::Connection> connection(const String& sessionId);
void removeConnection(const WebSocketMessageHandler::Connection&);
RefPtr<WebSocketListener> startListening(const String& sessionId);
String getResourceName(const String& sessionId);
String getWebSocketURL(const RefPtr<WebSocketListener>, const String& sessionId);
String getSessionID(const String& resource);
void sendMessage(const String& session, const String& message);
// Non-spec method
void removeResourceForSession(const String& sessionId);
void disconnectSession(const String& sessionId);
private:
WebSocketMessageHandler& m_messageHandler;
WebDriverService& m_service;
String m_listenerURL;
RefPtr<WebSocketListener> m_listener;
HashMap<WebSocketMessageHandler::Connection, String> m_connectionToSession;
#if USE(SOUP)
GRefPtr<SoupServer> m_soupServer;
std::vector<GRefPtr<SoupWebsocketConnection>> m_staticConnections;
#endif
};
}
|
