Server (config): moving variables to main program

Author: feberts

server/config.py

@@ -21,28 +21,25 @@
 """
 
 # SERVER:
-ip = '127.0.0.1' # IP or hostname
+ip = '127.0.0.1' # IP, domain name or empty string (= all interfaces)
 port = 4711
 
 # FRAMEWORK:
 game_timeout = 1000 # seconds, timeout for inactive games and for joining a game
 
 # LOGGING:
-log_server_errors = True # errors during tcp connections
-log_server_info = False # useful for debugging tcp connections (verbose)
-log_framework_request = True # client requests
-log_framework_response = True # server responses
-log_framework_actions = True # actions performed by the framework, such as terminating games
-
-# TCP CONNECTIONS:
-# pick a higher value for request_size_max if required by a new game
+log_server_errors = True      # errors related to client-server communication
+log_server_tcp = False        # useful for debugging TCP connections
+log_framework_request = True  # client requests such as moves, game state or join request
+log_framework_response = True # server responses such as game states or error messages
+log_framework_actions = True  # starting and terminating game sessions
+
+# TCP:
+# Pick a higher value for request_size_max if required by a new game.
 request_size_max = int(1e6) # bytes, prevents clients from sending too much data
 
-# it should not be necessary to change buffer_size or connection_timeout
-buffer_size = 4096 # bytes, corresponds to client-side buffer size value
-connection_timeout = 60 # seconds, timeout for tcp transactions
-
 # TLS:
-# to enable TLS, specify certificate and key (clients must enable TLS as well)
-tls_cert = ''
+# To enable TLS, specify certificate and key. Clients must enable TLS as well.
+# Enabled TLS is indicated by a log message on server startup.
+tls_cert = '' # certificate in PEM format
 tls_key = ''

server/game_server.py

@@ -41,6 +41,9 @@
 class ClientDisconnect(Exception): pass
 class RequestSizeExceeded(Exception): pass
 
+connection_timeout = 60 # seconds, timeout for tcp transactions
+buffer_size = 4096 # bytes, corresponds to client-side buffer size value
+
 def handle_connection(conn, client):
     """
     Handling a connection.
@@ -53,33 +56,32 @@ def handle_connection(conn, client):
 
     Data is expected to be received in JSON format and it is also sent back to
     the client in JSON format. The connection has a server side timeout and the
-    amount of data accepted in a single request is limited by the server. The
-    corresponding parameters are defined in the config module. Whenever
-    possible, error messages are sent back to the client.
+    amount of data accepted in a single request is limited by the server.
+    Whenever possible, error messages are sent back to the client.
 
     Parameters:
     conn (socket or SSLSocket): connection socket
     client (tuple(str, int)): client IP and port
     """
     ip, port = client
     log = utility.ServerLogger(ip, port)
-    log.info('connection accepted')
+    log.tcp('connection accepted')
 
-    conn.settimeout(config.connection_timeout)
+    conn.settimeout(connection_timeout)
 
     try:
         try:
             # receive data from client:
             request = bytearray()
 
             while True:
-                data = conn.recv(config.buffer_size)
+                data = conn.recv(buffer_size)
                 if not data: raise ClientDisconnect
                 request += data
                 if len(request) > config.request_size_max: raise RequestSizeExceeded
                 if request.endswith(b'EOT\0'): break
 
-            log.info(f'received {len(request)} bytes: {request}')
+            log.tcp(f'received {len(request)} bytes: {request}')
             request = request[:-4] # strip EOT
             request = json.loads(request.decode())
 
@@ -122,7 +124,7 @@ def handle_connection(conn, client):
                 response = json.dumps(response).encode()
 
             conn.sendall(response)
-            log.info(f'responding: {response}')
+            log.tcp(f'responding: {response}')
 
     except BrokenPipeError:
         log.error('connection closed by client after sending request')
@@ -132,7 +134,7 @@ def handle_connection(conn, client):
         log.error('unexpected exception on the server:\n' + traceback.format_exc())
     finally:
         conn.close()
-        log.info('connection closed by server')
+        log.tcp('connection closed by server')
 
 def secure_socket(socket):
     """
@@ -153,6 +155,7 @@ def secure_socket(socket):
             context.load_cert_chain(
                 certfile=utility.abs_path(config.tls_cert),
                 keyfile=utility.abs_path(config.tls_key))
+
             print('TLS enabled')
 
             return context.wrap_socket(socket, server_side=True)

server/utility.py

@@ -64,11 +64,11 @@ def __init__(self, ip=None, port=None):
         """
         self._client = f' {ip}:{port}' if ip else ''
 
-    def info(self, message):
+    def tcp(self, message):
         """
-        Log server information. See function _log for details.
+        Log TCP related information. See function _log for details.
         """
-        if config.log_server_info:
+        if config.log_server_tcp:
             self._log(message)
 
     def error(self, message):