+ return opts
+
+
+def server_test():
+ """Ensure valid server out file belonging to current process.
+
+ 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.")
+ 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():
+ """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 True:
+ 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()
+ now = time.time()
+ 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 = "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 map creator.
+ world_db["MAP"] = bytearray(b'.' * (world_db["MAP_LENGTH"] ** 2))
+
+
+def set_world_inactive():
+ """Set world_db["WORLD_ACTIVE"] to 0 and remove worldstate file."""
+ server_test()
+ if os.access(io_db["path_worldstate"], os.F_OK):
+ os.remove(io_db["path_worldstate"])
+ world_db["WORLD_ACTIVE"] = 0
+
+
+def integer_test(val_string, min, max):
+ """Return val_string if possible integer >= min and <= max, else None."""
+ try:
+ val = int(val_string)
+ if val < min or val > max:
+ raise ValueError
+ return val
+ except ValueError:
+ print("Ignoring: Please use integer >= " + str(min) + " and <= " +
+ str(max) + ".")
+ return None
+
+
+def setter(category, key, min, max):
+ """Build setter for world_db([category + "s"][id])[key] to >=min/<=max."""
+ if category is None:
+ def f(val_string):
+ val = integer_test(val_string, min, max)
+ if None != val:
+ world_db[key] = val
+ else:
+ if category == "Thing":
+ id_store = command_tid
+ decorator = test_Thing_id
+ elif category == "ThingType":
+ id_store = command_ttid
+ decorator = test_ThingType_id
+ elif category == "ThingAction":
+ id_store = command_taid
+ decorator = test_ThingAction_id
+
+ @decorator
+ def f(val_string):
+ val = integer_test(val_string, min, max)
+ if None != val:
+ world_db[category + "s"][id_store.id][key] = val
+ return f
+
+
+def command_ping():
+ """Send PONG line to server output file."""
+ io_db["file_out"].write("PONG\n")
+ io_db["file_out"].flush()
+
+
+def command_quit():
+ """Abort server process."""
+ raise SystemExit("received QUIT command")
+
+
+def command_seedmap(seed_string):
+ """Set world_db["SEED_MAP"] to int(seed_string), then (re-)make map."""
+ setter(None, "SEED_MAP", 0, 4294967295)(seed_string)
+ remake_map()
+
+
+def command_makeworld(seed_string):
+ # DUMMY.
+ setter(None, "SEED_MAP", 0, 4294967295)(seed_string)
+ setter(None, "SEED_RANDOMNESS", 0, 4294967295)(seed_string)
+ # TODO: Test for existence of player thing and 'wait' thing action?
+
+
+def command_maplength(maplength_string):
+ # DUMMY.
+ set_world_inactive()
+ # TODO: remove map
+ world_db["Things"] = {}
+ setter(None, "MAP_LENGTH", 1, 256)(maplength_string)
+
+
+def command_worldactive(worldactive_string):
+ # DUMMY.
+ val = integer_test(worldactive_string, 0, 1)
+ if val:
+ if 0 != world_db["WORLD_ACTIVE"] and 0 == val:
+ set_world_inactive()
+ elif 0 == world_db["WORLD_ACTIVE"]:
+ wait_exists = False
+ player_exists = False
+ map_exists = False
+ # TODO: perform tests:
+ # Is there thing action of name 'wait'?
+ # Is there a player thing?
+ # Is there a map?
+ if wait_exists and player_exists and map_exists:
+ # TODO: rebuild al things' FOVs, map memories
+ world_db["WORLD_ACTIVE"] = 1
+
+
+def id_setter(id_string, category, id_store, start_at_1=False):
+ """Set ID of object of category to manipulate ID unused? Create new one.
+
+ The ID is stored as id_store.id. If the integer of the input is valid (if
+ start_at_1, >= 0 and <= 255, else >= -32768 and <= 32767), but <0 or (if
+ start_at_1) <1, calculate new ID: lowest unused ID >=0 or (if start_at_1)
+ >= 1, and <= 255. None is always returned when no new object is created,
+ otherwise the new object's ID.
+ """
+ min = 0 if start_at_1 else -32768
+ max = 255 if start_at_1 else 32767
+ id = integer_test(id_string, min, max)
+ if None != id:
+ if id in world_db[category]:
+ id_store.id = id
+ return None
+ else:
+ if (start_at_1 and 0 == id) \
+ or ((not start_at_1) and (id < 0 or id > 255)):
+ id = -1
+ while 1:
+ id = id + 1
+ if id not in world_db[category]:
+ break
+ if id > 255:
+ print("Ignoring: "
+ "No unused ID available to add to ID list.")
+ return None
+ id_store.id = id
+ return id
+
+
+def test_for_id_maker(object, category):
+ """Return decorator testing for object having "id" attribute."""
+ def decorator(f):
+ def helper(*args):
+ if hasattr(object, "id"):
+ f(*args)
+ else:
+ print("Ignoring: No " + category +
+ " defined to manipulate yet.")
+ return helper
+ return decorator
+
+
+def command_tid(id_string):
+ """Set ID of Thing to manipulate. ID unused? Create new one.
+
+ Default new Thing's type to the first available ThingType, others: zero.
+ """
+ id = id_setter(id_string, "Things", command_tid)
+ if None != id:
+ if world_db["ThingTypes"] == {}:
+ print("Ignoring: No ThingType to settle new Thing in.")
+ return
+ world_db["Things"][id] = {
+ "T_LIFEPOINTS": 0,
+ "T_ARGUMENT": 0,
+ "T_PROGRESS": 0,
+ "T_SATIATION": 0,
+ "T_COMMAND": 0,
+ "T_TYPE": list(world_db["ThingTypes"].keys())[0],
+ "T_POSY": 0,
+ "T_POSX": 0,
+ "T_CARRIES": [],
+ "carried": False,
+ "T_MEMTHING": [],
+ "T_MEMMAP": False,
+ "T_MEMDEPTHMAP": False
+ }
+
+
+test_Thing_id = test_for_id_maker(command_tid, "Thing")
+
+
+@test_Thing_id
+def command_tcommand(str_int):
+ """Set T_COMMAND of selected Thing."""
+ val = integer_test(str_int, 0, 255)
+ if None != val:
+ if 0 == val or val in world_db["ThingActions"]:
+ world_db["Things"][command_tid.id]["T_COMMAND"] = val
+ else:
+ print("Ignoring: ThingAction ID belongs to no known ThingAction.")
+
+
+@test_Thing_id
+def command_ttype(str_int):
+ """Set T_TYPE of selected Thing."""
+ val = integer_test(str_int, 0, 255)
+ if None != val:
+ if val in world_db["ThingTypes"]:
+ world_db["Things"][command_tid.id]["T_TYPE"] = val
+ else:
+ print("Ignoring: ThingType ID belongs to no known ThingType.")
+
+
+@test_Thing_id
+def command_tcarries(str_int):
+ """Append int(str_int) to T_CARRIES of selected Thing.
+
+ The ID int(str_int) must not be of the selected Thing, and must belong to a
+ Thing with unset "carried" flag. Its "carried" flag will be set on owning.
+ """
+ val = integer_test(str_int, 0, 255)
+ if None != val:
+ if val == command_tid.id:
+ print("Ignoring: Thing cannot carry itself.")
+ elif val in world_db["Things"] \
+ and not world_db["Things"][val]["carried"]:
+ world_db["Things"][command_tid.id]["T_CARRIES"].append(val)
+ world_db["Things"][val]["carried"] = True
+ else:
+ print("Ignoring: Thing not available for carrying.")
+ # Note that the whole carrying structure is different from the C version:
+ # Carried-ness is marked by a "carried" flag, not by Things containing
+ # Things internally.
+
+
+@test_Thing_id
+def command_tmemthing(str_t, str_y, str_x):
+ """Add (int(str_t), int(str_y), int(str_x)) to selected Thing's T_MEMTHING.
+
+ The type must fit to an existing ThingType, and the position into the map.
+ """
+ type = integer_test(str_t, 0, 255)
+ posy = integer_test(str_y, 0, 255)
+ posx = integer_test(str_x, 0, 255)
+ if None != type and None != posy and None != posx:
+ if type not in world_db["ThingTypes"] \
+ or posy >= world_db["MAP_LENGTH"] or posx >= world_db["MAP_LENGTH"]:
+ print("Ignoring: Illegal value for thing type or position.")
+ else:
+ memthing = (type, posy, posx)
+ world_db["Things"][command_tid.id]["T_MEMTHING"].append(memthing)
+
+
+def setter_map(maptype):
+ """Set selected Thing's map of maptype's int(str_int)-th line to mapline.
+
+ If Thing has no map of maptype yet, initialize it with ' ' bytes first.
+ """
+ @test_Thing_id
+ def helper(str_int, mapline):
+ val = integer_test(str_int, 0, 255)
+ if None != val:
+ if val >= world_db["MAP_LENGTH"]:
+ print("Illegal value for map line number.")
+ elif len(mapline) != world_db["MAP_LENGTH"]:
+ print("Map line length is unequal map width.")
+ else:
+ length = world_db["MAP_LENGTH"]
+ rmap = None
+ if not world_db["Things"][command_tid.id][maptype]:
+ rmap = bytearray(b' ' * (length ** 2))
+ else:
+ rmap = world_db["Things"][command_tid.id][maptype]
+ rmap[val * length:(val * length) + length] = mapline.encode()
+ world_db["Things"][command_tid.id][maptype] = rmap
+ return helper
+
+
+def setter_tpos(axis):
+ """Generate setter for T_POSX or T_POSY of selected Thing."""
+ @test_Thing_id
+ def helper(str_int):
+ val = integer_test(str_int, 0, 255)
+ if None != val:
+ if val < world_db["MAP_LENGTH"]:
+ world_db["Things"][command_tid.id]["T_POS" + axis] = val
+ # TODO: Delete Thing's FOV, and rebuild it if world is active.
+ else:
+ print("Ignoring: Position is outside of map.")
+ return helper
+
+
+def command_ttid(id_string):
+ """Set ID of ThingType to manipulate. ID unused? Create new one.
+
+ Default new ThingType's TT_SYMBOL to "?", TT_CORPSE_ID to self, others: 0.
+ """
+ id = id_setter(id_string, "ThingTypes", command_ttid)
+ if None != id:
+ world_db["ThingTypes"][id] = {
+ "TT_NAME": "(none)",
+ "TT_CONSUMABLE": 0,
+ "TT_LIFEPOINTS": 0,
+ "TT_PROLIFERATE": 0,
+ "TT_START_NUMBER": 0,
+ "TT_SYMBOL": "?",
+ "TT_CORPSE_ID": id
+ }
+
+
+test_ThingType_id = test_for_id_maker(command_ttid, "ThingType")
+
+
+@test_ThingType_id
+def command_ttname(name):
+ """Set TT_NAME of selected ThingType."""
+ world_db["ThingTypes"][command_ttid.id]["TT_NAME"] = name
+
+
+@test_ThingType_id
+def command_ttsymbol(char):
+ """Set TT_SYMBOL of selected ThingType. """
+ if 1 == len(char):
+ world_db["ThingTypes"][command_ttid.id]["TT_SYMBOL"] = char
+ else:
+ print("Ignoring: Argument must be single character.")
+
+
+@test_ThingType_id
+def command_ttcorpseid(str_int):
+ """Set TT_CORPSE_ID of selected ThingType."""
+ val = integer_test(str_int, 0, 255)
+ if None != val:
+ if val in world_db["ThingTypes"]:
+ world_db["ThingTypes"][command_ttid.id]["TT_CORPSE_ID"] = val
+ else:
+ print("Ignoring: Corpse ID belongs to no known ThignType.")
+
+
+def command_taid(id_string):
+ """Set ID of ThingAction to manipulate. ID unused? Create new one.
+
+ Default new ThingAction's TA_EFFORT to 1, its TA_NAME to "wait".
+ """
+ id = id_setter(id_string, "ThingActions", command_taid, True)
+ if None != id:
+ world_db["ThingActions"][id] = {
+ "TA_EFFORT": 1,
+ "TA_NAME": "wait"
+ }
+
+
+test_ThingAction_id = test_for_id_maker(command_taid, "ThingAction")
+
+
+@test_ThingAction_id
+def command_taname(name):
+ """Set TA_NAME of selected ThingAction.
+
+ The name must match a valid thing action function. If after the name
+ setting no ThingAction with name "wait" remains, call set_world_inactive().
+ """
+ if name == "wait" or name == "move" or name == "use" or name == "drop" \
+ or name == "pick_up":
+ world_db["ThingActions"][command_taid.id]["TA_NAME"] = name
+ if 1 == world_db["WORLD_ACTIVE"]:
+ wait_defined = False
+ for id in world_db["ThingActions"]:
+ if "wait" == world_db["ThingActions"][id]["TA_NAME"]:
+ wait_defined = True
+ break
+ if not wait_defined:
+ set_world_inactive()
+ else:
+ print("Ignoring: Invalid action name.")
+ # In contrast to the original,naming won't map a function to a ThingAction.
+
+
+"""Commands database.
+
+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),
+ "SEED_MAP": (1, False, command_seedmap),
+ "SEED_RANDOMNESS": (1, False, setter(None, "SEED_RANDOMNESS",
+ 0, 4294967295)),
+ "TURN": (1, False, setter(None, "TURN", 0, 65535)),
+ "PLAYER_TYPE": (1, False, setter(None, "PLAYER_TYPE", 0, 255)),
+ "MAP_LENGTH": (1, False, command_maplength),
+ "WORLD_ACTIVE": (1, False, command_worldactive),
+ "TA_ID": (1, False, command_taid),
+ "TA_EFFORT": (1, False, setter("ThingAction", "TA_EFFORT", 0, 255)),
+ "TA_NAME": (1, False, command_taname),
+ "TT_ID": (1, False, command_ttid),
+ "TT_NAME": (1, False, command_ttname),
+ "TT_SYMBOL": (1, False, command_ttsymbol),
+ "TT_CORPSE_ID": (1, False, command_ttcorpseid),
+ "TT_CONSUMABLE": (1, False, setter("ThingType", "TT_CONSUMABLE",
+ 0, 65535)),
+ "TT_START_NUMBER": (1, False, setter("ThingType", "TT_START_NUMBER",
+ 0, 255)),
+ "TT_PROLIFERATE": (1, False, setter("ThingType", "TT_PROLIFERATE",
+ 0, 255)),
+ "TT_LIFEPOINTS": (1, False, setter("ThingType", "TT_LIFEPOINTS", 0, 255)),
+ "T_ID": (1, False, command_tid),
+ "T_ARGUMENT": (1, False, setter("Thing", "T_ARGUMENT", 0, 255)),
+ "T_PROGRESS": (1, False, setter("Thing", "T_PROGRESS", 0, 255)),
+ "T_LIFEPOINTS": (1, False, setter("Thing", "T_LIFEPOINTS", 0, 255)),
+ "T_SATIATION": (1, False, setter("Thing", "T_SATIATION", -32768, 32767)),
+ "T_COMMAND": (1, False, command_tcommand),
+ "T_TYPE": (1, False, command_ttype),
+ "T_CARRIES": (1, False, command_tcarries),
+ "T_MEMMAP": (2, False, setter_map("T_MEMMAP")),
+ "T_MEMDEPTHMAP": (2, False, setter_map("T_MEMDEPTHMAP")),
+ "T_MEMTHING": (3, False, command_tmemthing),
+ "T_POSY": (1, False, setter_tpos("Y")),
+ "T_POSX": (1, False, setter_tpos("X")),
+}
+
+
+"""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,
+ "ThingActions": {},
+ "ThingTypes": {},
+ "Things": {}
+}
+
+
+"""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()