-
Notifications
You must be signed in to change notification settings - Fork 10
/
WebSocketServer.php
291 lines (249 loc) · 8.3 KB
/
WebSocketServer.php
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
<?php
/**
* This file is a part of Woketo package.
*
* (c) Nekland <dev@nekland.fr>
*
* For the full license, take a look to the LICENSE file
* on the root directory of this project
*/
namespace Nekland\Woketo\Server;
use Nekland\Woketo\Exception\ConfigException;
use Nekland\Woketo\Exception\RuntimeException;
use Nekland\Woketo\Message\MessageHandlerInterface;
use Nekland\Woketo\Rfc6455\FrameFactory;
use Nekland\Woketo\Rfc6455\MessageFactory;
use Nekland\Woketo\Rfc6455\MessageHandler\CloseFrameHandler;
use Nekland\Woketo\Rfc6455\MessageHandler\RsvCheckFrameHandler;
use Nekland\Woketo\Rfc6455\MessageHandler\WrongOpcodeHandler;
use Nekland\Woketo\Rfc6455\MessageHandler\PingFrameHandler;
use Nekland\Woketo\Rfc6455\MessageProcessor;
use Nekland\Woketo\Rfc6455\ServerHandshake;
use Nekland\Woketo\Utils\SimpleLogger;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
use React\EventLoop\LoopInterface;
use React\Socket\ConnectionInterface;
use React\Socket\ServerInterface;
class WebSocketServer
{
/**
* @var int
*/
private $port;
/**
* @var string
*/
private $host;
/**
* @var ServerHandshake
*/
private $handshake;
/**
* @var MessageHandlerInterface[]
*/
private $messageHandlers;
/**
* @var array
*/
private $connections;
/**
* @var LoopInterface
*/
private $loop;
/**
* @var ServerInterface
*/
private $server;
/**
* @var MessageProcessor
*/
private $messageProcessor;
/**
* @var array
*/
private $config;
/**
* @var LoggerInterface
*/
private $logger;
/**
* @param int $port The number of the port to bind
* @param string $host The host to listen on (by default 127.0.0.1)
* @param array $config
*/
public function __construct($port, $host = '127.0.0.1', $config = [])
{
$this->setConfig($config);
$this->host = $host;
$this->port = $port;
$this->handshake = new ServerHandshake();
$this->connections = [];
$this->buildMessageProcessor();
// Some optimization
\gc_enable(); // As the process never stops, the garbage collector will be usefull, you may need to call it manually sometimes for performance purpose
\set_time_limit(0); // It's by default on most server for cli apps but better be sure of that fact
}
/**
* @param MessageHandlerInterface|string $messageHandler An instance of a class as string
* @param string $uri The URI you want to bind on
*/
public function setMessageHandler($messageHandler, $uri = '*')
{
if (!$messageHandler instanceof MessageHandlerInterface && !\is_string($messageHandler)) {
throw new \InvalidArgumentException('The message handler must be an instance of MessageHandlerInterface or a string.');
}
if (\is_string($messageHandler)) {
try {
$reflection = new \ReflectionClass($messageHandler);
if(!$reflection->implementsInterface('Nekland\Woketo\Message\MessageHandlerInterface')) {
throw new \InvalidArgumentException('The messageHandler must implement MessageHandlerInterface');
}
} catch (\ReflectionException $e) {
throw new \InvalidArgumentException('The messageHandler must be a string representing a class.');
}
}
$this->messageHandlers[$uri] = $messageHandler;
}
/**
* Launch the WebSocket server and an infinite loop that act on event.
*
* @throws \Exception
*/
public function start()
{
if ($this->config['prod'] && \extension_loaded('xdebug')) {
throw new \Exception('xdebug is enabled, it\'s a performance issue. Disable that extension or specify "prod" option to false.');
}
$this->loop = $this->loop ?? \React\EventLoop\Factory::create();
$this->server = $this->server ?? new \React\Socket\Server($this->loop);
if ($this->config['ssl']) {
$this->server = new \React\Socket\SecureServer($this->server, $this->loop, array_merge([
'local_cert' => $this->config['certFile'],
'passphrase' => $this->config['passphrase'],
], $this->config['sslContextOptions']));
$this->getLogger()->info('Enabled ssl');
}
$this->server->on('connection', function ($socketStream) {
$this->onNewConnection($socketStream);
});
$this->server->listen($this->port);
$this->getLogger()->info('Listening on ' . $this->host . ':' . $this->port);
$this->loop->run();
}
/**
* @param ConnectionInterface $socketStream
*/
private function onNewConnection(ConnectionInterface $socketStream)
{
$connection = new Connection($socketStream, function ($uri, Connection $connection) {
return $this->getMessageHandler($uri, $connection);
}, $this->loop, $this->messageProcessor);
$connection->setLogger($this->getLogger());
$this->connections[] = $connection;
}
/**
* @param string $uri
* @param Connection $connection
* @return MessageHandlerInterface|null
*/
private function getMessageHandler(string $uri, Connection $connection)
{
$handler = null;
if (!empty($this->messageHandlers[$uri])) {
$handler = $this->messageHandlers[$uri];
}
if (null === $handler && !empty($this->messageHandlers['*'])) {
$handler = $this->messageHandlers['*'];
}
if (null !== $handler) {
if (\is_string($handler)) {
$handler = new $handler;
}
return $handler;
}
return null;
}
/**
* Build the message processor with configuration
*/
private function buildMessageProcessor()
{
$this->messageProcessor = new MessageProcessor(
new FrameFactory($this->config['frame']),
new MessageFactory($this->config['message'])
);
$this->messageProcessor->addHandler(new PingFrameHandler());
$this->messageProcessor->addHandler(new CloseFrameHandler());
$this->messageProcessor->addHandler(new WrongOpcodeHandler());
$this->messageProcessor->addHandler(new RsvCheckFrameHandler());
foreach ($this->config['messageHandlers'] as $handler) {
if (!$handler instanceof MessageHandlerInterface) {
throw new RuntimeException(sprintf('%s is not an instance of MessageHandlerInterface but must be !', get_class($handler)));
}
}
}
/**
* Sets the configuration
*
* @param array $config
* @throws ConfigException
*/
private function setConfig(array $config)
{
$this->config = \array_merge([
'frame' => [],
'message' => [],
'messageHandlers' => [],
'prod' => true,
'ssl' => false,
'certFile' => '',
'passphrase' => '',
'sslContextOptions' => [],
], $config);
if ($this->config['ssl'] && !is_file($this->config['certFile'])) {
throw new ConfigException('With ssl configuration, you need to specify a certificate file.');
}
}
/**
* @return SimpleLogger|LoggerInterface
*/
public function getLogger()
{
if (null === $this->logger) {
return $this->logger = new SimpleLogger(!$this->config['prod']);
}
return $this->logger;
}
/**
* Allows you to set a custom logger
*
* @param LoggerInterface $logger
* @return WebSocketServer
*/
public function setLogger(LoggerInterface $logger)
{
$this->logger = $logger;
return $this;
}
/**
* Allows to specify a loop that will be used instead of the reactphp generated loop.
*
* @param LoopInterface $loop
* @return WebSocketServer
*/
public function setLoop(LoopInterface $loop)
{
$this->loop = $loop;
return $this;
}
/**
* @param ServerInterface $server
* @return WebSocketServer
*/
public function setSocketServer(ServerInterface $server)
{
$this->server = $server;
return $this;
}
}