home · contact · privacy
Server/py: In replay mode, replay until world turn >= replay argument.
[plomrogue] / plomrogue-server.py
index 2c9e70153077c1de9df54335c7d264260577733a..a3ee5e22f93053d3e58b2dfa261faea2b270cdf5 100755 (executable)
@@ -1,27 +1,28 @@
+import argparse
 import errno
 import os
+import shlex
+import shutil
 import time
 
 
-class HandledException(Exception):
-    """Feature-less Exception child. Use for expected operational errors."""
-
-    pass
-
-
 def setup_server_io(io_db):
     """Fill IO files DB with proper file( path)s. Write process IO test string.
 
-    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"]). Set worldstate file path io_db["path_worldstate"].
+    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"]).
     """
     io_dir = "server/"
     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"
     io_db["teststring"] = str(os.getpid()) + " " + str(time.time())
     os.makedirs(io_dir, exist_ok=True)
     io_db["file_out"] = open(io_db["path_out"], "w")
@@ -34,48 +35,124 @@ def setup_server_io(io_db):
 
 
 def cleanup_server_io(io_db):
-    """Close and remove all files in IO files DB."""
-    io_db["file_out"].close()
-    os.remove(io_db["path_out"])
-    io_db["file_in"].close()
-    os.remove(io_db["path_in"])
-    if "file_worldstate" in io_db:                    # This file's only set up
-        io_db["file_worldstate"].close()              # properly when the game
-    if os.access(io_db["path_worldstate"], os.F_OK):  # world is active, which
-        os.remove(io_db["path_worldstate"])           # is not guaranteed.
+    """Close and remove all files open in IO files DB."""
+    def helper(file_key, path_key):
+        if file_key in io_db:
+            io_db[file_key].close()
+            os.remove(io_db[path_key])
+    helper("file_out", "path_out")
+    helper("file_in", "path_in")
+    helper("file_worldstate", "path_worldstate")
 
 
-def detect_atomic_leftover(path):
-    """Raise HandledException if file is found at path + "_tmp"."""
-    path_tmp = path + "_tmp"
+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 HandledException(msg)
+        raise SystemExit(msg)
+
+
+def obey(cmd, io_db, prefix):
+    """"""
+    print("input " + prefix + ": " + cmd)
+    try:
+        tokens = shlex.split(cmd, comments=True)
+    except ValueError as err:
+        print("Can't tokenize command string: " + str(err) + ".")
+        return
+    if 0 == len(tokens):
+        pass
+    elif "PING" == tokens[0] and 1 == len(tokens):
+        io_db["file_out"].write("PONG\n")
+    elif "QUIT" == tokens[0] and 1 == len(tokens):
+        record("# " + cmd, path_recordfile)
+        raise SystemExit("received QUIT command")
+    elif "MAKE_WORLD" == tokens[0] and 2 == len(tokens):
+        print("I would generate a new world now, if only I knew how.")
+        record(cmd, io_db)
+    else:
+        print("Invalid command/argument, or bad number of tokens.")
+
+
+def record(cmd, io_db):
+    """Append cmd string plus newline to file at path_recordfile. (Atomic.)"""
+    # This misses some optimizations from the original record(), namely only
+    # finishing the atomic write with expensive flush() and fsync() every 15
+    # seconds unless explicitely forced. Implement as needed.
+    path_tmp = io_db["path_record"] + io_db["tmp_suffix"]
+    if os.access(io_db["path_record"], os.F_OK):
+        shutil.copyfile(io_db["path_record"], path_tmp)
+    file = open(path_tmp, "a")
+    file.write(cmd + "\n")
+    file.flush()
+    os.fsync(file.fileno())
+    file.close()
+    if os.access(io_db["path_record"], os.F_OK):
+        os.remove(io_db["path_record"])
+    os.rename(path_tmp, io_db["path_record"])
+
+
+def obey_lines_in_file(path, name, break_test = None):
+    """Call obey() on each line of path's file, use name in input prefix.
+
+    If break_test function is set, only read the file until it returns True.
+    """
+    file = open(path, "r")
+    line_n = 1
+    for line in file.readlines():
+        if None != break_test and break_test():
+            break
+        obey(line.rstrip(), io_db, name + "file line " + str(line_n))
+        line_n = line_n + 1
+    file.close()
+
+
+def make_turn_tester(turn_to_compare, world_db):
+    """Return tester whether world_db["turn"] greater/equal turn_to_compare."""
+    def turn_tester():
+        return world_db["turn"] >= turn_to_compare
+    return turn_tester
 
 
 io_db = {}
+world_db = {}
 try:
-    print("DUMMY: Obey command-line arguments.")
-    print("DUMMY: Open files.")
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-s', nargs='?', type=int, dest='replay', const=1,
+                        action='store')
     setup_server_io(io_db)
-    print("DUMMY: Run game.")
-    path_recordfile = "recordfile"
-    path_savefile = "savefile"
-    detect_atomic_leftover(path_savefile)
-    detect_atomic_leftover(path_recordfile)
-    if os.access(path_savefile, os.F_OK):
-        print(open(path_savefile, "r").read())
+    # print("DUMMY: Run game.")
+    detect_atomic_leftover(io_db["path_save"], io_db["tmp_suffix"])
+    detect_atomic_leftover(io_db["path_record"], io_db["tmp_suffix"])
+    opts, unknown = parser.parse_known_args()
+    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
+        break_tester = make_turn_tester(opts.replay, world_db)
+        obey_lines_in_file(io_db["path_record"], "record ", break_tester)
     else:
-        msg = "MAKE_WORLD " + str(int(time.time()))
-        print(msg)
-except HandledException as exception:
-    print("Error:")
-    print(exception.args[0])
+        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 ")
+            obey("MAKE_WORLD " + str(int(time.time())), io_db, "in file")
+        # print("DUMMY: Run io_loop().")
+except SystemExit as exit:
+    print("ABORTING: " + exit.args[0])
 except:
     print("SOMETHING WENT WRONG IN UNEXPECTED WAYS")
     raise
 finally:
     cleanup_server_io(io_db)
-    print("DUMMY: (Clean up C heap.)")
+    print("DUMMY: (Clean up C heap.)")