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()
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.
The command string is tokenized by shlex.split(comments=True). If replay is
set, a non-meta command from the commands_db merely triggers obey() on the
- next command from the records file. Non-meta commands are recorded in
- non-replay mode if do_record is set. The prefix string is inserted into the
- server's input message between its beginning 'input ' and ':'. All activity
- is preceded by a call to server_test().
+ next command from the records file. If not, and do do_record is set,
+ non-meta commands are recorded via record(), and save_world() is called.
+ The prefix string is inserted into the server's input message between its
+ beginning 'input ' & ':'. All activity is preceded by a server_test() call.
"""
server_test()
print("input " + prefix + ": " + command)
print("Can't tokenize command string: " + str(err) + ".")
return
if len(tokens) > 0 and tokens[0] in commands_db \
- and len(tokens) >= commands_db[tokens[0]][0] + 1:
+ and len(tokens) == commands_db[tokens[0]][0] + 1:
if commands_db[tokens[0]][1]:
commands_db[tokens[0]][2]()
elif replay:
else:
print("Reached end of record file.")
else:
- commands_db[tokens[0]][2]()
+ commands_db[tokens[0]][2](*tokens[1:])
if do_record:
record(command)
+ save_world()
else:
print("Invalid command/argument, or bad number of tokens.")
+def atomic_write(path, text, do_append=False):
+ """Atomic write of text to file at path, appended if do_append is set."""
+ path_tmp = path + io_db["tmp_suffix"]
+ mode = "w"
+ if do_append:
+ mode = "a"
+ if os.access(path, os.F_OK):
+ shutil.copyfile(path, path_tmp)
+ file = open(path_tmp, mode)
+ file.write(text)
+ file.flush()
+ os.fsync(file.fileno())
+ file.close()
+ if os.access(path, os.F_OK):
+ os.remove(path)
+ os.rename(path_tmp, path)
+
+
def record(command):
"""Append command string plus newline to record file. (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(command + "\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"])
+ atomic_write(io_db["path_record"], command + "\n", do_append=True)
+
+
+def save_world():
+ # Dummy for saving all commands to reconstruct current world state.
+ # Misses same optimizations as record() from the original record().
+ atomic_write(io_db["path_save"],
+ "WORLD_ACTIVE " + str(world_db["WORLD_ACTIVE"]) + "\n" +
+ "MAP_LENGTH " + str(world_db["MAP_LENGTH"]) + "\n" +
+ "PLAYER_TYPE " + str(world_db["PLAYER_TYPE"]) + "\n" +
+ "TURN " + str(world_db["TURN"]) + "\n" +
+ "SEED_RANDOMNESS " + str(world_db["SEED_RANDOMNESS"]) + "\n" +
+ "SEED_MAP " + str(world_db["SEED_MAP"]) + "\n")
+ # TODO: If all this ever does is just writing down what's in world_db, some
+ # loop over its entries should be all that's needed.
def obey_lines_in_file(path, name, do_record=False):
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.")
max_wait = 5
now = time.time()
command = ""
- while 1:
+ while True:
add = io_db["file_in"].readline()
if len(add) > 0:
command = command + add
return command
-def command_makeworld():
- """Mere dummy so far."""
- print("I would build a whole world now if only I knew how.")
+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 = "record 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 remake_map():
+ # DUMMY.
+ print("I'd (re-)make the map now, if only I knew how.")
+
+
+def worlddb_value_setter(key, min, max):
+ """Generate: Set world_db[key] to int(val_string) if >= min and <= max."""
+ def func(val_string):
+ try:
+ val = int(val_string)
+ if val < min or val > max:
+ raise ValueError
+ world_db[key] = val
+ except ValueError:
+ print("Ignoring: Please use integer >= " + str(min) + " and <= " +
+ str(max) + ".")
+ return func
def command_ping():
raise SystemExit("received QUIT command")
+def command_seedmap(seed_string):
+ """Set world_db["SEED_MAP"] to int(seed_string), then (re-)make map."""
+ worlddb_value_setter("SEED_MAP", 0, 4294967295)(seed_string)
+ remake_map()
+
+
+def command_makeworld(seed_string):
+ # DUMMY.
+ worlddb_value_setter("SEED_MAP", 0, 4294967295)(seed_string)
+ worlddb_value_setter("SEED_RANDOMNESS", 0, 4294967295)(seed_string)
+
+
+def command_maplength(maplength_string):
+ # DUMMY.
+ worlddb_value_setter("MAP_LENGTH", 1, 256)(maplength_string)
+
+
+def command_worldactive(worldactive_string):
+ # DUMMY.
+ worlddb_value_setter("WORLD_ACTIVE", 0, 255)(worldactive_string)
+
+
"""Commands database.
-Map command start tokens to ([0]) minimum number of expected command arguments,
-([1]) the command's meta-ness (i.e. is it to be written to the record file, is
-it to be ignored in replay mode if read from server input file), and ([2]) a
-function to be called on it.
+Map command start tokens to ([0]) number of expected command arguments, ([1])
+the command's meta-ness (i.e. is it to be written to the record file, is it to
+be ignored in replay mode if read from server input file), and ([2]) a function
+to be called on it.
"""
commands_db = {
"QUIT": (0, True, command_quit),
"PING": (0, True, command_ping),
- "MAKE_WORLD": (1, False, command_makeworld)
+ "MAKE_WORLD": (1, False, command_makeworld),
+ "SEED_MAP": (1, False, command_seedmap),
+ "SEED_RANDOMNESS": (1, False, worlddb_value_setter("SEED_RANDOMNESS", 0,
+ 4294967295)),
+ "TURN": (1, False, worlddb_value_setter("TURN", 0, 65535)),
+ "PLAYER_TYPE": (1, False, worlddb_value_setter("PLAYER_TYPE", 0, 255)),
+ "MAP_LENGTH": (1, False, command_maplength),
+ "WORLD_ACTIVE": (1, False, command_worldactive)
+}
+
+
+"""World state database. With sane default values."""
+world_db = {
+ "TURN": 1,
+ "SEED_MAP": 0,
+ "SEED_RANDOMNESS": 0,
+ "PLAYER_TYPE": 0,
+ "MAP_LENGTH": 64,
+ "WORLD_ACTIVE": 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
}
-io_db = {}
-world_db = {}
+
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: