9 def setup_server_io(io_db):
10 """Fill IO files DB with proper file( path)s. Write process IO test string.
12 Set io_db["kicked_by_rival"] to False. Decide file paths. Ensure IO files
13 directory at server/. Remove any old in file if found. Set up new in file
14 (io_db["file_in"]) for reading at io_db["path_in"], and new out file
15 (io_db["file_out"]) for writing at io_db["path_out"]. Start out file with
16 process hash line of format PID + " " + floated UNIX time
17 (io_db["teststring"]). Run detect_atomic_leftover on io_db["path_record"]
18 and io_db["path_save"].
21 io_db["kicked_by_rival"] = False
22 io_db["path_in"] = io_dir + "in"
23 io_db["path_out"] = io_dir + "out"
24 io_db["path_worldstate"] = io_dir + "worldstate"
25 io_db["path_record"] = "record"
26 io_db["path_save"] = "save"
27 io_db["path_worldconf"] = "confserver/world"
28 io_db["tmp_suffix"] = "_tmp"
29 io_db["teststring"] = str(os.getpid()) + " " + str(time.time())
30 os.makedirs(io_dir, exist_ok=True)
31 io_db["file_out"] = open(io_db["path_out"], "w")
32 io_db["file_out"].write(io_db["teststring"] + "\n")
33 io_db["file_out"].flush()
34 if os.access(io_db["path_in"], os.F_OK):
35 os.remove(io_db["path_in"])
36 io_db["file_in"] = open(io_db["path_in"], "w")
37 io_db["file_in"].close()
38 io_db["file_in"] = open(io_db["path_in"], "r")
39 detect_atomic_leftover(io_db["path_save"], io_db["tmp_suffix"])
40 detect_atomic_leftover(io_db["path_record"], io_db["tmp_suffix"])
43 def cleanup_server_io(io_db):
44 """Close and (if io_db["kicked_by_rival"] false) remove files in io_db."""
45 def helper(file_key, path_key):
47 io_db[file_key].close()
48 if not io_db["kicked_by_rival"] \
49 and os.access(io_db[path_key], os.F_OK):
50 os.remove(io_db[path_key])
51 helper("file_out", "path_out")
52 helper("file_in", "path_in")
53 helper("file_worldstate", "path_worldstate")
56 def detect_atomic_leftover(path, tmp_suffix):
57 """Raise explained SystemExit if file is found at path + tmp_suffix."""
58 path_tmp = path + tmp_suffix
59 msg = "Found file '" + path_tmp + "' that may be a leftover from an " \
60 "aborted previous attempt to write '" + path + "'. Aborting until " \
61 "the matter is resolved by removing it from its current path."
62 if os.access(path_tmp, os.F_OK):
66 def obey(cmd, io_db, prefix, replay_file=None, do_record=False):
69 print("input " + prefix + ": " + cmd)
71 tokens = shlex.split(cmd, comments=True)
72 except ValueError as err:
73 print("Can't tokenize command string: " + str(err) + ".")
77 elif "PING" == tokens[0] and 1 == len(tokens):
78 io_db["file_out"].write("PONG\n")
79 elif "QUIT" == tokens[0] and 1 == len(tokens):
81 record("# " + cmd, io_db)
82 raise SystemExit("received QUIT command")
83 elif "MAKE_WORLD" == tokens[0] and 2 == len(tokens):
85 print("Due to replay mode, reading command as 'go on in record'.")
86 line = replay_file.readline()
88 obey(line.rstrip(), io_db,
89 replay_file.prefix + str(file.line_n))
90 file.line_n = file.line_n + 1
92 print("Reached end of record file.")
94 print("I would generate a new world now, if only I knew how.")
98 print("Invalid command/argument, or bad number of tokens.")
101 def record(cmd, io_db):
102 """Append cmd string plus newline to file at path_recordfile. (Atomic.)"""
103 # This misses some optimizations from the original record(), namely only
104 # finishing the atomic write with expensive flush() and fsync() every 15
105 # seconds unless explicitely forced. Implement as needed.
106 path_tmp = io_db["path_record"] + io_db["tmp_suffix"]
107 if os.access(io_db["path_record"], os.F_OK):
108 shutil.copyfile(io_db["path_record"], path_tmp)
109 file = open(path_tmp, "a")
110 file.write(cmd + "\n")
112 os.fsync(file.fileno())
114 if os.access(io_db["path_record"], os.F_OK):
115 os.remove(io_db["path_record"])
116 os.rename(path_tmp, io_db["path_record"])
119 def obey_lines_in_file(path, name, do_record=False):
120 """Call obey() on each line of path's file, use name in input prefix."""
121 file = open(path, "r")
123 for line in file.readlines():
124 obey(line.rstrip(), io_db, name + "file line " + str(line_n),
130 def parse_command_line_arguments():
131 """Return settings values read from command line arguments."""
132 parser = argparse.ArgumentParser()
133 parser.add_argument('-s', nargs='?', type=int, dest='replay', const=1,
135 opts, unknown = parser.parse_known_args()
139 def server_test(io_db):
140 """Ensure valid server out file belonging to current process.
142 On failure, set io_db["kicked_by_rival"] and raise SystemExit.
144 if not os.access(io_db["path_out"], os.F_OK):
145 raise SystemExit("Server output file has disappeared.")
146 file = open(io_db["path_out"], "r")
147 test = file.readline().rstrip("\n")
149 if test != io_db["teststring"]:
150 io_db["kicked_by_rival"] = True
151 msg = "Server test string in server output file does not match. This" \
152 " indicates that the current server process has been " \
153 "superseded by another one."
154 raise SystemExit(msg)
157 def read_command(io_db):
158 """Return next newline-delimited command from server in file.
160 Keep building return string until a newline is encountered. Pause between
161 unsuccessful reads, and after too much waiting, run server_test().
168 add = io_db["file_in"].readline()
170 command = command + add
171 if len(command) > 0 and "\n" == command[-1]:
172 command = command[:-1]
175 time.sleep(wait_on_fail)
176 if now + max_wait < time.time():
185 opts = parse_command_line_arguments()
186 setup_server_io(io_db)
187 # print("DUMMY: Run game.")
188 if None != opts.replay:
191 print("Replay mode. Auto-replaying up to turn " + str(opts.replay) +
192 " (if so late a turn is to be found).")
193 if not os.access(io_db["path_record"], os.F_OK):
194 raise SystemExit("No record file found to replay.")
196 file = open(io_db["path_record"], "r")
197 file.prefix = "recod file line "
199 while world_db["turn"] < opts.replay:
200 obey(file.readline().rstrip(), io_db,
201 file.prefix + str(file.line_n))
202 file.line_n = file.line_n + 1
205 obey(read_command(io_db), io_db, "in file", replay_file=file)
210 if os.access(io_db["path_save"], os.F_OK):
211 obey_lines_in_file(io_db["path_save"], "save")
213 if not os.access(io_db["path_worldconf"], os.F_OK):
214 msg = "No world config file from which to start a new world."
215 raise SystemExit(msg)
216 obey_lines_in_file(io_db["path_worldconf"], "world config ",
218 obey("MAKE_WORLD " + str(int(time.time())), io_db, "in file",
221 obey(read_command(io_db), io_db, "in file", do_record=True)
222 except SystemExit as exit:
223 print("ABORTING: " + exit.args[0])
225 print("SOMETHING WENT WRONG IN UNEXPECTED WAYS")
228 cleanup_server_io(io_db)
229 # print("DUMMY: (Clean up C heap.)")