diff --git a/README.md b/README.md index bb3f65a..f0ac0da 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,12 @@ Websocket Server A minimal Websockets Server in Python with no external dependencies. - * Python3.5+ + * Python3.6+ * Clean simple API * Multiple clients * No dependencies -Notice that this implementation does not support the more advanced features -like multithreading etc. The project is focused mainly on making it easy to run a -websocket server for prototyping, testing or for making a GUI for your application. +Notice this project is focused mainly on making it easy to run a websocket server for prototyping, testing or for making a GUI for your application. Thus not all possible features of Websockets are supported. Installation @@ -73,14 +71,18 @@ The WebsocketServer can be initialized with the below parameters. | Method | Description | Takes | Gives | |-----------------------------|---------------------------------------------------------------------------------------|-----------------|-------| +| `run_forever()` | Runs server until shutdown_gracefully or shutdown_abruptly are called. | threaded: run server on its own thread if True | None | | `set_fn_new_client()` | Sets a callback function that will be called for every new `client` connecting to us | function | None | | `set_fn_client_left()` | Sets a callback function that will be called for every `client` disconnecting from us | function | None | | `set_fn_message_received()` | Sets a callback function that will be called when a `client` sends a message | function | None | | `send_message()` | Sends a `message` to a specific `client`. The message is a simple string. | client, message | None | | `send_message_to_all()` | Sends a `message` to **all** connected clients. The message is a simple string. | message | None | -| `shutdown_gracefully()` | Shutdown server by sending a websocket CLOSE handshake to all connected clients. | None | None | -| `shutdown_abruptly()` | Shutdown server without sending any websocket CLOSE handshake. | None | None | - +| `disconnect_clients_gracefully()` | Disconnect all connected clients by sending a websocket CLOSE handshake. | Optional: status, reason | None | +| `disconnect_clients_abruptly()` | Disconnect all connected clients. Clients won't be aware until they try to send some data. | None | None | +| `shutdown_gracefully()` | Disconnect clients with a CLOSE handshake and shutdown server. | Optional: status, reason | None | +| `shutdown_abruptly()` | Disconnect clients and shutdown server with no handshake. | None | None | +| `deny_new_connections()` | Close connection for new clients. | Optional: status, reason | None | +| `allow_new_connections()` | Allows back connection for new clients. | | None | ### Callback functions @@ -103,7 +105,7 @@ from websocket_server import WebsocketServer def new_client(client, server): server.send_message_to_all("Hey all, a new client has joined us") -server = WebsocketServer(13254, host='127.0.0.1', loglevel=logging.INFO) +server = WebsocketServer(host='127.0.0.1', port=13254, loglevel=logging.INFO) server.set_fn_new_client(new_client) server.run_forever() ```` @@ -115,7 +117,7 @@ from websocket_server import WebsocketServer def new_client(client, server): server.send_message_to_all("Hey all, a new client has joined us") -server = WebsocketServer(13254, host='127.0.0.1', loglevel=logging.INFO, key="key.pem", cert="cert.pem") +server = WebsocketServer(host='127.0.0.1', port=13254, loglevel=logging.INFO, key="key.pem", cert="cert.pem") server.set_fn_new_client(new_client) server.run_forever() ```` diff --git a/releases.txt b/releases.txt index bf5ef50..2fda06c 100644 --- a/releases.txt +++ b/releases.txt @@ -7,3 +7,28 @@ 0.5.4 - Add API for shutting down server (abruptly & gracefully) + +0.5.5 +- Allow running run_forever threaded +- Fix shutting down of a server without connected clients + +0.5.6 +- Support from Python3.6+ + +0.6.0 +- Change order of params 'host' and 'port' +- Add host attribute to server + +0.6.1 +- Sending data is now thread-safe + +0.6.2 +- Add API for disconnecting clients + +0.6.3 +- Remove deprecation warnings + +0.6.4 +- Add deny_new_connections & allow_new_connections +- Fix disconnect_clients_gracefully to now take params +- Fix shutdown_gracefully unused param diff --git a/server.py b/server.py index f0587c6..210c884 100644 --- a/server.py +++ b/server.py @@ -19,7 +19,7 @@ def message_received(client, server, message): PORT=9001 -server = WebsocketServer(PORT) +server = WebsocketServer(port = PORT) server.set_fn_new_client(new_client) server.set_fn_client_left(client_left) server.set_fn_message_received(message_received) diff --git a/setup.py b/setup.py index 238d764..684b88d 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ from distutils.command.install import install -VERSION = '0.5.4' +VERSION = '0.6.4' def get_tag_version(): @@ -53,4 +53,5 @@ def run(self): cmdclass={ 'verify': VerifyVersionCommand, }, + python_requires=">=3.6", ) diff --git a/tests/_bootstrap_.py b/tests/_bootstrap_.py deleted file mode 100644 index 646978f..0000000 --- a/tests/_bootstrap_.py +++ /dev/null @@ -1,6 +0,0 @@ -# Add path to source code -import sys, os -if os.getcwd().endswith('tests'): - sys.path.insert(0, '..') -elif os.path.exists('websocket_server'): - sys.path.insert(0, '.') diff --git a/tests/utils.py b/tests/conftest.py similarity index 78% rename from tests/utils.py rename to tests/conftest.py index 2230a51..d8ddf26 100644 --- a/tests/utils.py +++ b/tests/conftest.py @@ -5,7 +5,12 @@ import pytest import websocket # websocket-client -import _bootstrap_ +# Add path to source code +import sys, os +if os.getcwd().endswith('tests'): + sys.path.insert(0, '..') +elif os.path.exists('websocket_server'): + sys.path.insert(0, '.') from websocket_server import WebsocketServer @@ -57,33 +62,31 @@ def handle_received_message(self, client, server, message): @pytest.fixture(scope='function') -def server(): +def threaded_server(): """ Returns the response of a server after""" - s = TestServer(0, loglevel=logging.DEBUG) - server_thread = Thread(target=s.run_forever) - server_thread.daemon = True - server_thread.start() - yield s - s.server_close() + server = TestServer(loglevel=logging.DEBUG) + server.run_forever(threaded=True) + yield server + server.server_close() @pytest.fixture -def session(server): +def session(threaded_server): """ Gives a simple connection to a server """ - conn = websocket.create_connection("ws://{}:{}".format(*server.server_address)) - yield conn, server + conn = websocket.create_connection("ws://{}:{}".format(*threaded_server.server_address)) + yield conn, threaded_server conn.close() @pytest.fixture -def client_session(server): +def client_session(threaded_server): """ Gives a TestClient instance connected to a server """ - client = TestClient(port=server.port) + client = TestClient(port=threaded_server.port) sleep(1) assert client.ws.sock and client.ws.sock.connected - yield client, server + yield client, threaded_server client.ws.close() diff --git a/tests/test_handshake.py b/tests/test_handshake.py index dfbcc36..74ace26 100644 --- a/tests/test_handshake.py +++ b/tests/test_handshake.py @@ -1,4 +1,3 @@ -import _bootstrap_ from websocket_server import WebSocketHandler diff --git a/tests/test_message_lengths.py b/tests/test_message_lengths.py index 14fec70..03f9d96 100644 --- a/tests/test_message_lengths.py +++ b/tests/test_message_lengths.py @@ -1,96 +1,67 @@ -from time import sleep -import logging -from threading import Thread - -import pytest -from websocket import create_connection # websocket-client - -import _bootstrap_ -from websocket_server import WebsocketServer - - -@pytest.fixture(scope='function') -def server(): - """ Returns the response of a server after""" - s = WebsocketServer(0, loglevel=logging.DEBUG) - server_thread = Thread(target=s.run_forever) - server_thread.daemon = True - server_thread.start() - yield s - s.server_close() - - -@pytest.fixture -def session(server): - ws = create_connection("ws://{}:{}".format(*server.server_address)) - yield ws, server - ws.close() - - def test_text_message_of_length_1(session): - client, server = session + conn, server = session server.send_message_to_all('$') - assert client.recv() == '$' + assert conn.recv() == '$' def test_text_message_of_length_125B(session): - client, server = session + conn, server = session msg = 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqr125' server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg def test_text_message_of_length_126B(session): - client, server = session + conn, server = session msg = 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrs126' server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg def test_text_message_of_length_127B(session): - client, server = session + conn, server = session msg = 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrst127' server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg def test_text_message_of_length_208B(session): - client, server = session + conn, server = session msg = 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvw208' server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg def test_text_message_of_length_1251B(session): - client, server = session + conn, server = session msg = ('abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqr125'*10)+'1' server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg def test_text_message_of_length_68KB(session): - client, server = session + conn, server = session msg = '$'+('a'*67993)+'68000'+'^' assert len(msg) == 68000 server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg def test_text_message_of_length_1500KB(session): """ An enormous message (well beyond 65K) """ - client, server = session + conn, server = session msg = '$'+('a'*1499991)+'1500000'+'^' assert len(msg) == 1500000 server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg diff --git a/tests/test_server.py b/tests/test_server.py index fed63b5..d03ce08 100644 --- a/tests/test_server.py +++ b/tests/test_server.py @@ -1,84 +1,159 @@ -from utils import session, client_session, server from time import sleep +import threading import websocket import pytest -def test_send_close(client_session): - """ - Ensure client stops receiving data once we send_close (socket is still open) - """ - client, server = client_session - assert client.received_messages == [] - - server.send_message_to_all("test1") - sleep(0.5) - assert client.received_messages == ["test1"] - - # After CLOSE, client should not be receiving any messages - server.clients[-1]["handler"].send_close() - sleep(0.5) - server.send_message_to_all("test2") - sleep(0.5) - assert client.received_messages == ["test1"] - - -def test_shutdown_gracefully(client_session): - client, server = client_session - assert client.ws.sock and client.ws.sock.connected - assert server.socket.fileno() > 0 - - server.shutdown_gracefully() - sleep(0.5) - - # Ensure all parties disconnected - assert not client.ws.sock - assert server.socket.fileno() == -1 - assert not server.clients - - -def test_shutdown_abruptly(client_session): - client, server = client_session - assert client.ws.sock and client.ws.sock.connected - assert server.socket.fileno() > 0 - - server.shutdown_abruptly() - sleep(0.5) - - # Ensure server socket died - assert server.socket.fileno() == -1 - - # Ensure client handler terminated - assert server.received_messages == [] - assert client.errors == [] - client.ws.send("1st msg after server shutdown") - sleep(0.5) - - # Note the message is received since the client handler - # will terminate only once it has received the last message - # and break out of the keep_alive loop. Any consecutive messages - # will not be received though. - assert server.received_messages == ["1st msg after server shutdown"] - assert len(client.errors) == 1 - assert isinstance(client.errors[0], websocket._exceptions.WebSocketConnectionClosedException) - - # Try to send 2nd message - with pytest.raises(websocket._exceptions.WebSocketConnectionClosedException): - client.ws.send("2nd msg after server shutdown") - - -def test_client_closes_gracefully(session): - client, server = session - assert client.connected - assert server.clients - old_client_handler = server.clients[0]["handler"] - client.close() - assert not client.connected - - # Ensure server closed connection. - # We test this by having the server trying to send - # data to the client - assert not server.clients - with pytest.raises(BrokenPipeError): - old_client_handler.connection.send(b"test") +class TestServerThreadedWithoutClient(): + def test_run_forever(self, threaded_server): + assert threaded_server.thread + assert not isinstance(threaded_server.thread, threading._MainThread) + assert threaded_server.thread.is_alive() + + def test_attributes(self, threaded_server): + tpl = threaded_server.server_address + assert threaded_server.port == tpl[1] + assert threaded_server.host == tpl[0] + + def test_shutdown(self, threaded_server): + assert threaded_server.thread.is_alive() + + # Shutdown de-facto way + # REF: https://docs.python.org/3/library/socketserver.html + # "Tell the serve_forever() loop to stop and + # wait until it does. shutdown() must be called while serve_forever() + # is running in a different thread otherwise it will deadlock." + threaded_server.shutdown() + assert not threaded_server.thread.is_alive() + + def test_shutdown_gracefully_without_clients(self, threaded_server): + assert threaded_server.thread.is_alive() + threaded_server.shutdown_gracefully() + assert not threaded_server.thread.is_alive() + assert threaded_server.socket.fileno() <= 0 + + def test_shutdown_abruptly_without_clients(self, threaded_server): + assert threaded_server.thread.is_alive() + threaded_server.shutdown_abruptly() + assert not threaded_server.thread.is_alive() + assert threaded_server.socket.fileno() <= 0 + + +class TestServerThreadedWithClient(): + def test_send_close(self, client_session): + """ + Ensure client stops receiving data once we send_close (socket is still open) + """ + client, server = client_session + assert client.received_messages == [] + + server.send_message_to_all("test1") + sleep(0.5) + assert client.received_messages == ["test1"] + + # After CLOSE, client should not be receiving any messages + server.clients[-1]["handler"].send_close() + sleep(0.5) + server.send_message_to_all("test2") + sleep(0.5) + assert client.received_messages == ["test1"] + + def test_shutdown_gracefully(self, client_session): + client, server = client_session + assert client.ws.sock and client.ws.sock.connected + assert server.socket.fileno() > 0 + + server.shutdown_gracefully() + sleep(0.5) + + # Ensure all parties disconnected + assert not client.ws.sock + assert server.socket.fileno() == -1 + assert not server.clients + + def test_shutdown_abruptly(self, client_session): + client, server = client_session + assert client.ws.sock and client.ws.sock.connected + assert server.socket.fileno() > 0 + + server.shutdown_abruptly() + sleep(0.5) + + # Ensure server socket died + assert server.socket.fileno() == -1 + + # Ensure client handler terminated + assert server.received_messages == [] + assert client.errors == [] + client.ws.send("1st msg after server shutdown") + sleep(0.5) + + # Note the message is received since the client handler + # will terminate only once it has received the last message + # and break out of the keep_alive loop. Any consecutive messages + # will not be received though. + assert server.received_messages == ["1st msg after server shutdown"] + assert len(client.errors) == 1 + assert isinstance(client.errors[0], websocket._exceptions.WebSocketConnectionClosedException) + + # Try to send 2nd message + with pytest.raises(websocket._exceptions.WebSocketConnectionClosedException): + client.ws.send("2nd msg after server shutdown") + + def test_client_closes_gracefully(self, session): + client, server = session + assert client.connected + assert server.clients + old_client_handler = server.clients[0]["handler"] + client.close() + assert not client.connected + + # Ensure server closed connection. + # We test this by having the server trying to send + # data to the client + assert not server.clients + with pytest.raises(BrokenPipeError): + old_client_handler.connection.send(b"test") + + def test_disconnect_clients_abruptly(self, session): + client, server = session + assert client.connected + assert server.clients + server.disconnect_clients_abruptly() + assert not server.clients + + # Client won't be aware until trying to write more data + with pytest.raises(BrokenPipeError): + for i in range(3): + client.send("test") + sleep(0.2) + + def test_disconnect_clients_gracefully(self, session): + client, server = session + assert client.connected + assert server.clients + server.disconnect_clients_gracefully() + assert not server.clients + + # Client won't be aware until trying to write more data + with pytest.raises(BrokenPipeError): + for i in range(3): + client.send("test") + sleep(0.2) + + def test_deny_new_connections(self, threaded_server): + url = "ws://{}:{}".format(*threaded_server.server_address) + server = threaded_server + server.deny_new_connections(status=1013, reason=b"Please try re-connecting later") + + conn = websocket.create_connection(url) + try: + conn.send("test") + except websocket.WebSocketProtocolException as e: + assert 'Invalid close opcode' in e.args[0] + assert not server.clients + + server.allow_new_connections() + conn = websocket.create_connection(url) + conn.send("test") diff --git a/tests/test_text_messages.py b/tests/test_text_messages.py index 28dd4e6..b4f2d0f 100644 --- a/tests/test_text_messages.py +++ b/tests/test_text_messages.py @@ -1,89 +1,86 @@ -from utils import session, server - - def test_text_message_of_length_1(session): - client, server = session + conn, server = session server.send_message_to_all('$') - assert client.recv() == '$' + assert conn.recv() == '$' def test_text_message_of_length_125B(session): - client, server = session + conn, server = session msg = 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqr125' server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg def test_text_message_of_length_126B(session): - client, server = session + conn, server = session msg = 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrs126' server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg def test_text_message_of_length_127B(session): - client, server = session + conn, server = session msg = 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrst127' server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg def test_text_message_of_length_208B(session): - client, server = session + conn, server = session msg = 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvw208' server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg def test_text_message_of_length_1251B(session): - client, server = session + conn, server = session msg = ('abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz'\ 'abcdefghijklmnopqr125'*10)+'1' server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg def test_text_message_of_length_68KB(session): - client, server = session + conn, server = session msg = '$'+('a'*67993)+'68000'+'^' assert len(msg) == 68000 server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg def test_text_message_of_length_1500KB(session): """ An enormous message (well beyond 65K) """ - client, server = session + conn, server = session msg = '$'+('a'*1499991)+'1500000'+'^' assert len(msg) == 1500000 server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg def test_text_message_with_unicode_characters(session): - client, server = session + conn, server = session msg = '$äüö^' server.send_message_to_all(msg) - assert client.recv() == msg + assert conn.recv() == msg def test_text_message_stress_bursts(session): - """ Scenario: server sends multiple different message to the same client + """ Scenario: server sends multiple different message to the same conn at once """ from threading import Thread NUM_THREADS = 100 MESSAGE_LEN = 1000 - client, server = session + conn, server = session messages_received = [] # Threads receing @@ -91,7 +88,7 @@ def test_text_message_stress_bursts(session): for i in range(NUM_THREADS): th = Thread( target=lambda fn: messages_received.append(fn()), - args=(client.recv,) + args=(conn.recv,) ) th.daemon = True threads_receiving.append(th) diff --git a/websocket_server/thread.py b/websocket_server/thread.py new file mode 100644 index 0000000..a474203 --- /dev/null +++ b/websocket_server/thread.py @@ -0,0 +1,38 @@ +import threading + + +class ThreadWithLoggedException(threading.Thread): + """ + Similar to Thread but will log exceptions to passed logger. + + Args: + logger: Logger instance used to log any exception in child thread + + Exception is also reachable via .exception from the main thread. + """ + + DIVIDER = "*"*80 + + def __init__(self, *args, **kwargs): + try: + self.logger = kwargs.pop("logger") + except KeyError: + raise Exception("Missing 'logger' in kwargs") + super().__init__(*args, **kwargs) + self.exception = None + + def run(self): + try: + if self._target is not None: + self._target(*self._args, **self._kwargs) + except Exception as exception: + thread = threading.current_thread() + self.exception = exception + self.logger.exception(f"{self.DIVIDER}\nException in child thread {thread}: {exception}\n{self.DIVIDER}") + finally: + del self._target, self._args, self._kwargs + + +class WebsocketServerThread(ThreadWithLoggedException): + """Dummy wrapper to make debug messages a bit more readable""" + pass diff --git a/websocket_server/websocket_server.py b/websocket_server/websocket_server.py index e637607..c954c34 100644 --- a/websocket_server/websocket_server.py +++ b/websocket_server/websocket_server.py @@ -9,9 +9,11 @@ import logging from socket import error as SocketError import errno - +import threading from socketserver import ThreadingMixIn, TCPServer, StreamRequestHandler +from websocket_server.thread import WebsocketServerThread + logger = logging.getLogger(__name__) logging.basicConfig() @@ -51,16 +53,8 @@ class API(): - def run_forever(self): - try: - logger.info("Listening on port %d for clients.." % self.port) - self.serve_forever() - except KeyboardInterrupt: - self.server_close() - logger.info("Server terminated.") - except Exception as e: - logger.error(str(e), exc_info=True) - exit(1) + def run_forever(self, threaded=False): + return self._run_forever(threaded) def new_client(self, client, server): pass @@ -86,12 +80,24 @@ def send_message(self, client, msg): def send_message_to_all(self, msg): self._multicast(msg) + def deny_new_connections(self, status=CLOSE_STATUS_NORMAL, reason=DEFAULT_CLOSE_REASON): + self._deny_new_connections(status, reason) + + def allow_new_connections(self): + self._allow_new_connections() + def shutdown_gracefully(self, status=CLOSE_STATUS_NORMAL, reason=DEFAULT_CLOSE_REASON): - self._shutdown_gracefully(status=CLOSE_STATUS_NORMAL, reason=DEFAULT_CLOSE_REASON) + self._shutdown_gracefully(status, reason) def shutdown_abruptly(self): self._shutdown_abruptly() + def disconnect_clients_gracefully(self, status=CLOSE_STATUS_NORMAL, reason=DEFAULT_CLOSE_REASON): + self._disconnect_clients_gracefully(status, reason) + + def disconnect_clients_abruptly(self): + self._disconnect_clients_abruptly() + class WebsocketServer(ThreadingMixIn, TCPServer, API): """ @@ -118,9 +124,10 @@ class WebsocketServer(ThreadingMixIn, TCPServer, API): allow_reuse_address = True daemon_threads = True # comment to keep threads alive until finished - def __init__(self, port, host='127.0.0.1', loglevel=logging.WARNING, key=None, cert=None): + def __init__(self, host='127.0.0.1', port=0, loglevel=logging.WARNING, key=None, cert=None): logger.setLevel(loglevel) TCPServer.__init__(self, (host, port), WebSocketHandler) + self.host = host self.port = self.socket.getsockname()[1] self.key = key @@ -128,6 +135,29 @@ def __init__(self, port, host='127.0.0.1', loglevel=logging.WARNING, key=None, c self.clients = [] self.id_counter = 0 + self.thread = None + + self._deny_clients = False + + def _run_forever(self, threaded): + cls_name = self.__class__.__name__ + try: + logger.info("Listening on port %d for clients.." % self.port) + if threaded: + self.daemon = True + self.thread = WebsocketServerThread(target=super().serve_forever, daemon=True, logger=logger) + logger.info(f"Starting {cls_name} on thread {self.thread.getName()}.") + self.thread.start() + else: + self.thread = threading.current_thread() + logger.info(f"Starting {cls_name} on main thread.") + super().serve_forever() + except KeyboardInterrupt: + self.server_close() + logger.info("Server terminated.") + except Exception as e: + logger.error(str(e), exc_info=True) + sys.exit(1) def _message_received_(self, handler, msg): self.message_received(self.handler_to_client(handler), self, msg) @@ -139,6 +169,13 @@ def _pong_received_(self, handler, msg): pass def _new_client_(self, handler): + if self._deny_clients: + status = self._deny_clients["status"] + reason = self._deny_clients["reason"] + handler.send_close(status, reason) + self._terminate_client_handler(handler) + return + self.id_counter += 1 client = { 'id': self.id_counter, @@ -166,46 +203,75 @@ def handler_to_client(self, handler): if client['handler'] == handler: return client + def _terminate_client_handler(self, handler): + handler.keep_alive = False + handler.finish() + handler.connection.close() + def _terminate_client_handlers(self): """ Ensures request handler for each client is terminated correctly """ for client in self.clients: - client["handler"].keep_alive = False - client["handler"].finish() - client["handler"].connection.close() + self._terminate_client_handler(client["handler"]) def _shutdown_gracefully(self, status=CLOSE_STATUS_NORMAL, reason=DEFAULT_CLOSE_REASON): """ Send a CLOSE handshake to all connected clients before terminating server """ self.keep_alive = False - - # Send CLOSE to clients - for client in self.clients: - client["handler"].send_close(CLOSE_STATUS_NORMAL, reason) - - self._terminate_client_handlers() + self._disconnect_clients_gracefully(status, reason) self.server_close() + self.shutdown() def _shutdown_abruptly(self): """ Terminate server without sending a CLOSE handshake """ self.keep_alive = False - self._terminate_client_handlers() + self._disconnect_clients_abruptly() self.server_close() + self.shutdown() + + def _disconnect_clients_gracefully(self, status=CLOSE_STATUS_NORMAL, reason=DEFAULT_CLOSE_REASON): + """ + Terminate clients gracefully without shutting down the server + """ + for client in self.clients: + client["handler"].send_close(status, reason) + self._terminate_client_handlers() + + def _disconnect_clients_abruptly(self): + """ + Terminate clients abruptly (no CLOSE handshake) without shutting down the server + """ + self._terminate_client_handlers() + + def _deny_new_connections(self, status, reason): + self._deny_clients = { + "status": status, + "reason": reason, + } + + def _allow_new_connections(self): + self._deny_clients = False class WebSocketHandler(StreamRequestHandler): def __init__(self, socket, addr, server): self.server = server + assert not hasattr(self, "_send_lock"), "_send_lock already exists" + self._send_lock = threading.Lock() if server.key and server.cert: try: - socket = ssl.wrap_socket(socket, server_side=True, certfile=server.cert, keyfile=server.key) - except: # Not sure which exception it throws if the key/cert isn't found - logger.warn("SSL not available (are the paths {} and {} correct for the key and cert?)".format(server.key, server.cert)) + ssl_context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH) + ssl_context.load_cert_chain(certfile=server.cert, keyfile=server.key) + socket = ssl_context.wrap_socket(socket, server_side=True) + except FileNotFoundError: + logger.warning("SSL key or certificate file not found. Please check the paths for the key and cert.") + except ssl.SSLError as e: + logger.warning(f"SSL error occurred: {e}") StreamRequestHandler.__init__(self, socket, addr, server) def setup(self): @@ -246,14 +312,14 @@ def read_next_message(self): self.keep_alive = 0 return if not masked: - logger.warn("Client must always be masked.") + logger.warning("Client must always be masked.") self.keep_alive = 0 return if opcode == OPCODE_CONTINUATION: - logger.warn("Continuation frames are not supported.") + logger.warning("Continuation frames are not supported.") return elif opcode == OPCODE_BINARY: - logger.warn("Binary frames are not supported.") + logger.warning("Binary frames are not supported.") return elif opcode == OPCODE_TEXT: opcode_handler = self.server._message_received_ @@ -262,7 +328,7 @@ def read_next_message(self): elif opcode == OPCODE_PONG: opcode_handler = self.server._pong_received_ else: - logger.warn("Unknown opcode %#x." % opcode) + logger.warning("Unknown opcode %#x." % opcode) self.keep_alive = 0 return @@ -303,7 +369,8 @@ def send_close(self, status=CLOSE_STATUS_NORMAL, reason=DEFAULT_CLOSE_REASON): # Send CLOSE with status & reason header.append(FIN | OPCODE_CLOSE_CONN) header.append(payload_length) - self.request.send(header + payload) + with self._send_lock: + self.request.send(header + payload) def send_text(self, message, opcode=OPCODE_TEXT): """ @@ -346,7 +413,8 @@ def send_text(self, message, opcode=OPCODE_TEXT): raise Exception("Message is too big. Consider breaking it into chunks.") return - self.request.send(header + payload) + with self._send_lock: + self.request.send(header + payload) def read_http_headers(self): headers = {} @@ -379,7 +447,8 @@ def handshake(self): return response = self.make_handshake_response(key) - self.handshake_done = self.request.send(response.encode()) + with self._send_lock: + self.handshake_done = self.request.send(response.encode()) self.valid_client = True self.server._new_client_(self)