home · contact · privacy
Server/py: Flush PONG! message.
[plomrogue] / plomrogue-server.py
index a3ee5e22f93053d3e58b2dfa261faea2b270cdf5..c7d5ddead9351e40025904fdf87014c14cc51105 100755 (executable)
@@ -9,13 +9,16 @@ import time
 def setup_server_io(io_db):
     """Fill IO files DB with proper file( path)s. Write process IO test string.
 
-    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"]).
+    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"].
     """
     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"
@@ -27,19 +30,24 @@ def setup_server_io(io_db):
     os.makedirs(io_dir, 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()
     if os.access(io_db["path_in"], os.F_OK):
         os.remove(io_db["path_in"])
     io_db["file_in"] = open(io_db["path_in"], "w")
     io_db["file_in"].close()
     io_db["file_in"] = open(io_db["path_in"], "r")
+    detect_atomic_leftover(io_db["path_save"], io_db["tmp_suffix"])
+    detect_atomic_leftover(io_db["path_record"], io_db["tmp_suffix"])
 
 
 def cleanup_server_io(io_db):
-    """Close and remove all files open in IO files DB."""
+    """Close and (if io_db["kicked_by_rival"] false) remove files in io_db."""
     def helper(file_key, path_key):
         if file_key in io_db:
             io_db[file_key].close()
-            os.remove(io_db[path_key])
+            if not io_db["kicked_by_rival"] \
+               and os.access(io_db[path_key], os.F_OK):
+                os.remove(io_db[path_key])
     helper("file_out", "path_out")
     helper("file_in", "path_in")
     helper("file_worldstate", "path_worldstate")
@@ -55,8 +63,9 @@ def detect_atomic_leftover(path, tmp_suffix):
         raise SystemExit(msg)
 
 
-def obey(cmd, io_db, prefix):
+def obey(cmd, io_db, prefix, replay_file=None, do_record=False):
     """"""
+    server_test(io_db)
     print("input " + prefix + ": " + cmd)
     try:
         tokens = shlex.split(cmd, comments=True)
@@ -67,12 +76,25 @@ def obey(cmd, io_db, prefix):
         pass
     elif "PING" == tokens[0] and 1 == len(tokens):
         io_db["file_out"].write("PONG\n")
+        io_db["file_out"].flush()
     elif "QUIT" == tokens[0] and 1 == len(tokens):
-        record("# " + cmd, path_recordfile)
+        if do_record:
+            record("# " + cmd, io_db)
         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)
+        if replay_file:
+            print("Due to replay mode, reading command as 'go on in record'.")
+            line = replay_file.readline()
+            if len(line) > 0:
+                obey(line.rstrip(), io_db,
+                     replay_file.prefix + str(file.line_n))
+                file.line_n = file.line_n + 1
+            else:
+                print("Reached end of record file.")
+        else:
+            print("I would generate a new world now, if only I knew how.")
+            if do_record:
+                record(cmd, io_db)
     else:
         print("Invalid command/argument, or bad number of tokens.")
 
@@ -95,39 +117,75 @@ def record(cmd, io_db):
     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.
-    """
+def obey_lines_in_file(path, name, do_record=False):
+    """Call obey() on each line of path's file, use name in input prefix."""
     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))
+        obey(line.rstrip(), io_db, name + "file line " + str(line_n),
+             do_record=do_record)
         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
+def parse_command_line_arguments():
+    """Return settings values read from command line arguments."""
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-s', nargs='?', type=int, dest='replay', const=1,
+                        action='store')
+    opts, unknown = parser.parse_known_args()
+    return opts
+
+
+def server_test(io_db):
+    """Ensure valid server out file belonging to current process.
+
+    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.")
+    file = open(io_db["path_out"], "r")
+    test = file.readline().rstrip("\n")
+    file.close()
+    if test != io_db["teststring"]:
+        io_db["kicked_by_rival"] = True
+        msg = "Server test string in server output file does not match. This" \
+              " indicates that the current server process has been " \
+              "superseded by another one."
+        raise SystemExit(msg)
+
+
+def read_command(io_db):
+    """Return next newline-delimited command from server in file.
+
+    Keep building return string until a newline is encountered. Pause between
+    unsuccessful reads, and after too much waiting, run server_test().
+    """
+    wait_on_fail = 1
+    max_wait = 5
+    now = time.time()
+    command = ""
+    while 1:
+        add = io_db["file_in"].readline()
+        if len(add) > 0:
+            command = command + add
+            if len(command) > 0 and "\n" == command[-1]:
+                command = command[:-1]
+                break
+        else:
+            time.sleep(wait_on_fail)
+            if now + max_wait < time.time():
+                server_test(io_db)
+                now = time.time()
+    return command
 
 
 io_db = {}
 world_db = {}
 try:
-    parser = argparse.ArgumentParser()
-    parser.add_argument('-s', nargs='?', type=int, dest='replay', const=1,
-                        action='store')
+    opts = parse_command_line_arguments()
     setup_server_io(io_db)
     # 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
@@ -136,8 +194,19 @@ try:
         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)
+        file = open(io_db["path_record"], "r")
+        file.prefix = "recod file line "
+        file.line_n = 1
+        while world_db["turn"] < opts.replay:
+            obey(file.readline().rstrip(), io_db,
+                 file.prefix + str(file.line_n))
+            file.line_n = file.line_n + 1
+        try:
+            while 1:
+                obey(read_command(io_db), io_db, "in file", replay_file=file)
+        except SystemExit:
+            file.close()
+            raise
     else:
         if os.access(io_db["path_save"], os.F_OK):
             obey_lines_in_file(io_db["path_save"], "save")
@@ -145,9 +214,12 @@ try:
             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().")
+            obey_lines_in_file(io_db["path_worldconf"], "world config ",
+                               do_record=True)
+            obey("MAKE_WORLD " + str(int(time.time())), io_db, "in file",
+                 do_record=True)
+        while 1:
+            obey(read_command(io_db), io_db, "in file", do_record=True)
 except SystemExit as exit:
     print("ABORTING: " + exit.args[0])
 except: