home · contact · privacy
Server/py: More refactoring, documentation.
[plomrogue] / plomrogue-server.py
index 064f87283e960eb47c427ef981bb9439525f99ee..8c926526df5dcbc2d1d53b34ab40647a27d31272 100755 (executable)
@@ -9,25 +9,21 @@ import time
 def setup_server_io():
     """Fill IO files DB with proper file( path)s. Write process IO test string.
 
-    Set io_db["kicked_by_rival"] to False. Decide file paths. Ensure IO files
-    directory at server/. Remove any old in file if found. Set up new in file
-    (io_db["file_in"]) for reading at io_db["path_in"], and new out file
-    (io_db["file_out"]) for writing at io_db["path_out"]. Start out file with
-    process hash line of format PID + " " + floated UNIX time
-    (io_db["teststring"]). Run detect_atomic_leftover on io_db["path_record"]
-    and io_db["path_save"].
+    Ensure IO files directory at server/. Remove any old input file if found.
+    Set up new input file for reading, and new output file for writing. Start
+    output file with process hash line of format PID + " " + floated UNIX time
+    (io_db["teststring"]). Raise SystemExit if file is found at path of either
+    record or save file plus io_db["tmp_suffix"].
     """
-    io_dir = "server/"
-    io_db["kicked_by_rival"] = False
-    io_db["path_in"] = io_dir + "in"
-    io_db["path_out"] = io_dir + "out"
-    io_db["path_worldstate"] = io_dir + "worldstate"
-    io_db["path_record"] = "record"
-    io_db["path_save"] = "save"
-    io_db["path_worldconf"] = "confserver/world"
-    io_db["tmp_suffix"] = "_tmp"
+    def detect_atomic_leftover(path, tmp_suffix):
+        path_tmp = path + tmp_suffix
+        msg = "Found file '" + path_tmp + "' that may be a leftover from an " \
+              "aborted previous attempt to write '" + path + "'. Aborting " \
+             "until matter is resolved by removing it from its current path."
+        if os.access(path_tmp, os.F_OK):
+            raise SystemExit(msg)
     io_db["teststring"] = str(os.getpid()) + " " + str(time.time())
-    os.makedirs(io_dir, exist_ok=True)
+    os.makedirs(io_db["path_server"], exist_ok=True)
     io_db["file_out"] = open(io_db["path_out"], "w")
     io_db["file_out"].write(io_db["teststring"] + "\n")
     io_db["file_out"].flush()
@@ -55,16 +51,6 @@ def cleanup_server_io():
         io_db["file_record"].close()
 
 
-def detect_atomic_leftover(path, tmp_suffix):
-    """Raise explained SystemExit if file is found at path + tmp_suffix."""
-    path_tmp = path + tmp_suffix
-    msg = "Found file '" + path_tmp + "' that may be a leftover from an " \
-          "aborted previous attempt to write '" + path + "'. Aborting until " \
-          "the matter is resolved by removing it from its current path."
-    if os.access(path_tmp, os.F_OK):
-        raise SystemExit(msg)
-
-
 def obey(command, prefix, replay=False, do_record=False):
     """Call function from commands_db mapped to command's first token.
 
@@ -82,10 +68,10 @@ def obey(command, prefix, replay=False, do_record=False):
     except ValueError as err:
         print("Can't tokenize command string: " + str(err) + ".")
         return
-    if len(tokens) > 0 and tokens[0] in commands \
-       and len(tokens) >= commands[tokens[0]][0] + 1:
-        if commands[tokens[0]][1]:
-            commands[tokens[0]][2]()
+    if len(tokens) > 0 and tokens[0] in commands_db \
+       and len(tokens) >= commands_db[tokens[0]][0] + 1:
+        if commands_db[tokens[0]][1]:
+            commands_db[tokens[0]][2]()
         elif replay:
             print("Due to replay mode, reading command as 'go on in record'.")
             line = io_db["file_record"].readline()
@@ -96,7 +82,7 @@ def obey(command, prefix, replay=False, do_record=False):
             else:
                 print("Reached end of record file.")
         else:
-            commands[tokens[0]][2]()
+            commands_db[tokens[0]][2]()
             if do_record:
                 record(command)
     else:
@@ -144,7 +130,9 @@ def parse_command_line_arguments():
 def server_test():
     """Ensure valid server out file belonging to current process.
 
-    On failure, set io_db["kicked_by_rival"] and raise SystemExit.
+    This is done by comparing io_db["teststring"] to what's found at the start
+    of the current file at io_db["path_out"]. On failure, set
+    io_db["kicked_by_rival"] and raise SystemExit.
     """
     if not os.access(io_db["path_out"], os.F_OK):
         raise SystemExit("Server output file has disappeared.")
@@ -169,7 +157,7 @@ def read_command():
     max_wait = 5
     now = time.time()
     command = ""
-    while 1:
+    while True:
         add = io_db["file_in"].readline()
         if len(add) > 0:
             command = command + add
@@ -184,6 +172,53 @@ def read_command():
     return command
 
 
+def replay_game():
+    """Replay game from record file.
+
+    Use opts.replay as breakpoint turn to which to replay automatically before
+    switching to manual input by non-meta commands in server input file
+    triggering further reads of record file. Ensure opts.replay is at least 1.
+    """
+    if opts.replay < 1:
+        opts.replay = 1
+    print("Replay mode. Auto-replaying up to turn " + str(opts.replay) +
+          " (if so late a turn is to be found).")
+    if not os.access(io_db["path_record"], os.F_OK):
+        raise SystemExit("No record file found to replay.")
+    io_db["file_record"] = open(io_db["path_record"], "r")
+    io_db["file_record"].prefix = "recod file line "
+    io_db["file_record"].line_n = 1
+    while world_db["turn"] < opts.replay:
+        line = io_db["file_record"].readline()
+        if "" == line:
+            break
+        obey(line.rstrip(), io_db["file_record"].prefix
+             + str(io_db["file_record"].line_n))
+        io_db["file_record"].line_n = io_db["file_record"].line_n + 1
+    while True:
+        obey(read_command(), "in file", replay=True)
+
+
+def play_game():
+    """Play game by server input file commands. Before, load save file found.
+
+    If no save file is found, a new world is generated from the commands in the
+    world config plus a 'MAKE WORLD [current Unix timestamp]'. Record this
+    command and all that follow via the server input file.
+    """
+    if os.access(io_db["path_save"], os.F_OK):
+        obey_lines_in_file(io_db["path_save"], "save")
+    else:
+        if not os.access(io_db["path_worldconf"], os.F_OK):
+            msg = "No world config file from which to start a new world."
+            raise SystemExit(msg)
+        obey_lines_in_file(io_db["path_worldconf"], "world config ",
+                           do_record=True)
+        obey("MAKE_WORLD " + str(int(time.time())), "in file", do_record=True)
+    while True:
+        obey(read_command(), "in file", do_record=True)
+
+
 def command_makeworld():
     """Mere dummy so far."""
     print("I would build a whole world now if only I knew how.")
@@ -213,45 +248,35 @@ commands_db = {
     "MAKE_WORLD": (1, False, command_makeworld)
 }
 
-io_db = {}
-world_db = {}
+
+"""World state database,"""
+world_db = {
+    "turn": 0
+}
+
+
+"""File IO database."""
+io_db = {
+    "path_save": "save",
+    "path_record": "record",
+    "path_worldconf": "confserver/world",
+    "path_server": "server/",
+    "path_in": "server/in",
+    "path_out": "server/out",
+    "path_worldstate": "server/worldstate",
+    "tmp_suffix": "_tmp",
+    "kicked_by_rival": False
+}
+
+
 try:
     opts = parse_command_line_arguments()
     setup_server_io()
     # print("DUMMY: Run game.")
     if None != opts.replay:
-        if opts.replay < 1:
-            opts.replay = 1
-        print("Replay mode. Auto-replaying up to turn " + str(opts.replay) +
-              " (if so late a turn is to be found).")
-        if not os.access(io_db["path_record"], os.F_OK):
-            raise SystemExit("No record file found to replay.")
-        world_db["turn"] = 0
-        io_db["file_record"] = open(io_db["path_record"], "r")
-        io_db["file_record"].prefix = "recod file line "
-        io_db["file_record"].line_n = 1
-        while world_db["turn"] < opts.replay:
-            line = io_db["file_record"].readline()
-            if "" == line:
-                break
-            obey(line.rstrip(), io_db["file_record"].prefix
-                 + str(io_db["file_record"].line_n))
-            io_db["file_record"].line_n = io_db["file_record"].line_n + 1
-        while True:
-            obey(read_command(), "in file", replay=True)
+        replay_game()
     else:
-        if os.access(io_db["path_save"], os.F_OK):
-            obey_lines_in_file(io_db["path_save"], "save")
-        else:
-            if not os.access(io_db["path_worldconf"], os.F_OK):
-                msg = "No world config file from which to start a new world."
-                raise SystemExit(msg)
-            obey_lines_in_file(io_db["path_worldconf"], "world config ",
-                               do_record=True)
-            obey("MAKE_WORLD " + str(int(time.time())), "in file",
-                 do_record=True)
-        while True:
-            obey(read_command(), "in file", do_record=True)
+        play_game()
 except SystemExit as exit:
     print("ABORTING: " + exit.args[0])
 except: