plomlompom.com Git - plomrogue2-experiments/blob - server.py

   1 #!/usr/bin/env python3
   2
   3 import socketserver
   4 import threading
   5 import queue
   6 from parser import ArgError, Parser
   7
   8
   9 # Avoid "Address already in use" errors.
  10 socketserver.TCPServer.allow_reuse_address = True
  11
  12
  13 class Server(socketserver.ThreadingTCPServer):
  14     """Bind together threaded IO handling server and message queue."""
  15
  16     def __init__(self, queue, *args, **kwargs):
  17         super().__init__(*args, **kwargs)
  18         self.queue_out = queue
  19         self.daemon_threads = True  # Else, server's threads have daemon=False.
  20
  21
  22 class IO_Handler(socketserver.BaseRequestHandler):
  23
  24     def handle(self):
  25         """Move messages between network socket and main thread via queues.
  26
  27         On start, sets up new queue, sends it via self.server.queue_out to
  28         main thread, and from then on receives messages to send back from the
  29         main thread via that new queue.
  30
  31         At the same time, loops over socket's recv to get messages from the
  32         outside via self.server.queue_out into the main thread. Ends connection
  33         once a 'QUIT' message is received from socket, and then also kills its
  34         own queue.
  35
  36         All messages to the main thread are tuples, with the first element a
  37         meta command ('ADD_QUEUE' for queue creation, 'KILL_QUEUE' for queue
  38         deletion, and 'COMMAND' for everything else), the second element a UUID
  39         that uniquely identifies the thread (so that the main thread knows whom
  40         to send replies back to), and optionally a third element for further
  41         instructions.
  42         """
  43         import plom_socket_io
  44
  45         def caught_send(socket, message):
  46             """Send message by socket, catch broken socket connection error."""
  47             try:
  48                 plom_socket_io.send(socket, message)
  49             except plom_socket_io.BrokenSocketConnection:
  50                 pass
  51
  52         def send_queue_messages(socket, queue_in, thread_alive):
  53             """Send messages via socket from queue_in while thread_alive[0]."""
  54             while thread_alive[0]:
  55                 try:
  56                     msg = queue_in.get(timeout=1)
  57                 except queue.Empty:
  58                     continue
  59                 caught_send(socket, msg)
  60
  61         import uuid
  62         print('CONNECTION FROM:', str(self.client_address))
  63         connection_id = uuid.uuid4()
  64         queue_in = queue.Queue()
  65         self.server.queue_out.put(('ADD_QUEUE', connection_id, queue_in))
  66         thread_alive = [True]
  67         t = threading.Thread(target=send_queue_messages,
  68                              args=(self.request, queue_in, thread_alive))
  69         t.start()
  70         for message in plom_socket_io.recv(self.request):
  71             if message is None:
  72                 caught_send(self.request, 'BAD MESSAGE')
  73             elif 'QUIT' == message:
  74                 caught_send(self.request, 'BYE')
  75                 break
  76             else:
  77                 self.server.queue_out.put(('COMMAND', connection_id, message))
  78         self.server.queue_out.put(('KILL_QUEUE', connection_id))
  79         thread_alive[0] = False
  80         print('CONNECTION CLOSED FROM:', str(self.client_address))
  81         self.request.close()
  82
  83
  84 class Task:
  85
  86     def __init__(self, name, args=(), kwargs={}):
  87         self.name = name
  88         self.args = args
  89         self.kwargs = kwargs
  90         self.todo = 1
  91
  92
  93 class Thing:
  94
  95     def __init__(self, type_, position):
  96         self.type = type_
  97         self.position = position
  98         self.task = Task('wait')
  99
 100     def task_wait(self):
 101         pass
 102
 103     def task_move(self, direction):
 104         if direction == 'UP':
 105             self.position[0] -= 1
 106         elif direction == 'DOWN':
 107             self.position[0] += 1
 108         elif direction == 'RIGHT':
 109             self.position[1] += 1
 110         elif direction == 'LEFT':
 111             self.position[1] -= 1
 112
 113     def decide_task(self):
 114         if self.position[1] > 1:
 115             self.set_task('move', 'LEFT')
 116         elif self.position[1] < 3:
 117             self.set_task('move', 'RIGHT')
 118         else:
 119             self.set_task('wait')
 120
 121     def set_task(self, task, *args, **kwargs):
 122         self.task = Task(task, args, kwargs)
 123
 124     def proceed(self, is_AI=True):
 125         """Further the thing in its tasks.
 126
 127         Decrements .task.todo; if it thus falls to <= 0, enacts method whose
 128         name is 'task_' + self.task.name and sets .task = None. If is_AI, calls
 129         .decide_task to decide a self.task.
 130         """
 131         self.task.todo -= 1
 132         if self.task.todo <= 0:
 133             task = getattr(self, 'task_' + self.task.name)
 134             task(*self.task.args, **self.task.kwargs)
 135             self.task = None
 136         if is_AI and self.task is None:
 137             self.decide_task()
 138
 139
 140 class World:
 141
 142     def __init__(self):
 143         self.turn = 0
 144         self.map_size = (5, 5)
 145         self.map_ = 'xxxxx\n' +\
 146                     'x...x\n' +\
 147                     'x.X.x\n' +\
 148                     'x...x\n' +\
 149                     'xxxxx'
 150         self.things = [Thing('human', [3, 3]), Thing('monster', [1, 1])]
 151         self.player_i = 0
 152         self.player = self.things[self.player_i]
 153
 154
 155 def fib(n):
 156     """Calculate n-th Fibonacci number. Very inefficiently."""
 157     if n in (1, 2):
 158         return 1
 159     else:
 160         return fib(n-1) + fib(n-2)
 161
 162
 163 class CommandHandler:
 164
 165     def __init__(self, queues_out):
 166         from multiprocessing import Pool
 167         self.queues_out = queues_out
 168         self.world = World()
 169         self.parser = Parser(self)
 170         # self.pool and self.pool_result are currently only needed by the FIB
 171         # command and the demo of a parallelized game loop in cmd_inc_p.
 172         self.pool = Pool()
 173         self.pool_result = None
 174
 175     def handle_input(self, input_, connection_id):
 176         """Process input_ to command grammar, call command handler if found."""
 177         try:
 178             command = self.parser.parse(input_)
 179             if command is None:
 180                 self.send_to(connection_id, 'UNHANDLED INPUT')
 181             else:
 182                 command(connection_id=connection_id)
 183         except ArgError as e:
 184             self.send_to(connection_id, 'ARGUMENT ERROR: ' + str(e))
 185
 186     def send_to(self, connection_id, msg):
 187         """Send msg to client of connection_id."""
 188         self.queues_out[connection_id].put(msg)
 189
 190     def send_all(self, msg):
 191         """Send msg to all clients."""
 192         for connection_id in self.queues_out:
 193             self.send_to(connection_id, msg)
 194
 195     def stringify_yx(self, tuple_):
 196         """Transform tuple (y,x) into string 'Y:'+str(y)+',X:'+str(x)."""
 197         return 'Y:' + str(tuple_[0]) + ',X:' + str(tuple_[1])
 198
 199     def quoted(self, string):
 200         """Quote and escape string so client interprets it as single token."""
 201         quoted = []
 202         quoted += ['"']
 203         for c in string:
 204             if c in {'"', '\\'}:
 205                 quoted += ['\\']
 206             quoted += [c]
 207         quoted += ['"']
 208         return ''.join(quoted)
 209
 210     def send_all_gamestate(self):
 211         """Send out game state data relevant to clients."""
 212         self.send_all('NEW_TURN ' + str(self.world.turn))
 213         self.send_all('MAP_SIZE ' + self.stringify_yx(self.world.map_size))
 214         self.send_all('TERRAIN\n' + self.quoted(self.world.map_))
 215         for thing in self.world.things:
 216             self.send_all('THING TYPE:' + thing.type + ' '
 217                           + self.stringify_yx(thing.position))
 218
 219     def proceed_to_next_player_turn(self, connection_id):
 220         """Run game world turns until player can decide their next step.
 221
 222         Sends a 'TURN_FINISHED' message, then iterates through all non-player
 223         things, on each step furthering them in their tasks (and letting them
 224         decide new ones if they finish). The iteration order is: first all
 225         things that come after the player in the world things list, then (after
 226         incrementing the world turn) all that come before the player; then the
 227         player's .proceed() is run, and if it does not finish his task, the
 228         loop starts at the beginning. Once the player's task is finished, the
 229         loop breaks, and client-relevant game data is sent.
 230         """
 231         self.send_all('TURN_FINISHED ' + str(self.world.turn))
 232         while True:
 233             for thing in self.world.things[self.world.player_i+1:]:
 234                 thing.proceed()
 235             self.world.turn += 1
 236             for thing in self.world.things[:self.world.player_i]:
 237                 thing.proceed()
 238             self.world.player.proceed(is_AI=False)
 239             if self.world.player.task is None:
 240                 break
 241         self.send_all_gamestate()
 242
 243     def cmd_MOVE(self, direction, connection_id):
 244         """Set player task to 'move' with direction arg, finish player turn."""
 245         if direction not in {'UP', 'DOWN', 'RIGHT', 'LEFT'}:
 246             raise ArgError('Move argument must be one of: '
 247                            'UP, DOWN, RIGHT, LEFT')
 248         self.world.player.set_task('move', direction=direction)
 249         self.proceed_to_next_player_turn(connection_id)
 250     cmd_MOVE.argtypes = 'string'
 251
 252     def cmd_WAIT(self, connection_id):
 253         """Set player task to 'wait', finish player turn."""
 254         self.world.player.set_task('wait')
 255         self.proceed_to_next_player_turn(connection_id)
 256
 257     def cmd_GET_TURN(self, connection_id):
 258         """Send world.turn to caller."""
 259         self.send_to(connection_id, str(self.world.turn))
 260
 261     def cmd_ECHO(self, msg, connection_id):
 262         """Send msg to caller."""
 263         self.send_to(connection_id, msg)
 264     cmd_ECHO.argtypes = 'string'
 265
 266     def cmd_ALL(self, msg, connection_id):
 267         """Send msg to all clients."""
 268         self.send_all(msg)
 269     cmd_ALL.argtypes = 'string'
 270
 271     def cmd_FIB(self, numbers, connection_id):
 272         """Reply with n-th Fibonacci numbers, n taken from tokens[1:].
 273
 274         Numbers are calculated in parallel as far as possible, using fib().
 275         A 'CALCULATING …' message is sent to caller before the result.
 276         """
 277         self.send_to(connection_id, 'CALCULATING …')
 278         results = self.pool.map(fib, numbers)
 279         reply = ' '.join([str(r) for r in results])
 280         self.send_to(connection_id, reply)
 281     cmd_FIB.argtypes = 'seq:int:nonneg'
 282
 283     def cmd_INC_P(self, connection_id):
 284         """Increment world.turn, send game turn data to everyone.
 285
 286         To simulate game processing waiting times, a one second delay between
 287         TURN_FINISHED and NEW_TURN occurs; after NEW_TURN, some expensive
 288         calculations are started as pool processes that need to be finished
 289         until a further INC finishes the turn.
 290
 291         This is just a demo structure for how the game loop could work when
 292         parallelized. One might imagine a two-step game turn, with a non-action
 293         step determining actor tasks (the AI determinations would take the
 294         place of the fib calculations here), and an action step wherein these
 295         tasks are performed (where now sleep(1) is).
 296         """
 297         from time import sleep
 298         if self.pool_result is not None:
 299             self.pool_result.wait()
 300         self.send_all('TURN_FINISHED ' + str(self.world.turn))
 301         sleep(1)
 302         self.world.turn += 1
 303         self.send_all_gamestate()
 304         self.pool_result = self.pool.map_async(fib, (35, 35))
 305
 306
 307 def io_loop(q):
 308     """Handle commands coming through queue q, send results back.
 309
 310     Commands from q are expected to be tuples, with the first element either
 311     'ADD_QUEUE', 'COMMAND', or 'KILL_QUEUE', the second element a UUID, and
 312     an optional third element of arbitrary type. The UUID identifies a
 313     receiver for replies.
 314
 315     An 'ADD_QUEUE' command should contain as third element a queue through
 316     which to send messages back to the sender of the command. A 'KILL_QUEUE'
 317     command removes the queue for that receiver from the list of queues through
 318     which to send replies.
 319
 320     A 'COMMAND' command is specified in greater detail by a string that is the
 321     tuple's third element. CommandHandler takes care of processing this and
 322     sending out replies.
 323     """
 324     queues_out = {}
 325     command_handler = CommandHandler(queues_out)
 326     while True:
 327         x = q.get()
 328         command_type = x[0]
 329         connection_id = x[1]
 330         content = None if len(x) == 2 else x[2]
 331         if command_type == 'ADD_QUEUE':
 332             queues_out[connection_id] = content
 333         elif command_type == 'COMMAND':
 334             command_handler.handle_input(content, connection_id)
 335         elif command_type == 'KILL_QUEUE':
 336             del queues_out[connection_id]
 337
 338
 339 q = queue.Queue()
 340 c = threading.Thread(target=io_loop, daemon=True, args=(q,))
 341 c.start()
 342 server = Server(q, ('localhost', 5000), IO_Handler)
 343 try:
 344     server.serve_forever()
 345 except KeyboardInterrupt:
 346     pass
 347 finally:
 348     print('Killing server')
 349     server.server_close()