home · contact · privacy
Server/py: Fix writing out TT_CORPSE_ID commands to early to save file.
[plomrogue] / plomrogue-server.py
index 8c926526df5dcbc2d1d53b34ab40647a27d31272..092355bb43de61b72b8f8522a0d10c1a72099945 100755 (executable)
@@ -56,10 +56,10 @@ def obey(command, prefix, replay=False, do_record=False):
 
     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)
@@ -69,7 +69,7 @@ def obey(command, prefix, replay=False, do_record=False):
         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:
@@ -82,29 +82,78 @@ def obey(command, prefix, replay=False, do_record=False):
             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)
-    else:
+                save_world()
+    elif 0 != len(tokens):
         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().
+    ta_string = ""
+    for id in world_db["ThingActions"]:
+        ta = world_db["ThingActions"][id]
+        ta_string = ta_string + "TA_ID " + str(id) + "\n" + \
+                                "TA_EFFORT " + str(ta["TA_EFFORT"]) + "\n" + \
+                                "TA_NAME '" + ta["TA_NAME"] + "'\n"
+    tt_string = ""
+    for id in world_db["ThingTypes"]:
+        tt = world_db["ThingTypes"][id]
+        tt_string = tt_string + "TT_ID " + str(id) + "\n" + \
+                                "TT_CONSUMABLE " + \
+                                str(tt["TT_CONSUMABLE"]) + "\n" + \
+                                "TT_LIFEPOINTS " + \
+                                str(tt["TT_LIFEPOINTS"]) + "\n" + \
+                                "TT_PROLIFERATE " + \
+                                str(tt["TT_PROLIFERATE"]) + "\n" + \
+                                "TT_START_NUMBER " + \
+                                str(tt["TT_START_NUMBER"]) + "\n" + \
+                                "TT_NAME '" + tt["TT_NAME"] + "'\n" + \
+                                "TT_SYMBOL '" + tt["TT_SYMBOL"] + "'\n"
+    for id in world_db["ThingTypes"]:
+        tt = world_db["ThingTypes"][id]
+        tt_string = tt_string + "TT_ID " + str(id) + "\n" + \
+                                "TT_CORPSE_ID " + \
+                                str(tt["TT_CORPSE_ID"]) + "\n"
+    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" +
+                 ta_string + tt_string)
+    # 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):
@@ -186,9 +235,9 @@ def replay_game():
     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 = "recod file line "
+    io_db["file_record"].prefix = "record file line "
     io_db["file_record"].line_n = 1
-    while world_db["turn"] < opts.replay:
+    while world_db["TURN"] < opts.replay:
         line = io_db["file_record"].readline()
         if "" == line:
             break
@@ -219,9 +268,39 @@ def play_game():
         obey(read_command(), "in file", do_record=True)
 
 
-def command_makeworld():
-    """Mere dummy so far."""
-    print("I would build a whole world now if only I knew how.")
+def remake_map():
+    # DUMMY.
+    print("I'd (re-)make the map now, if only I knew how.")
+
+
+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 worlddb_value_setter(key, min, max):
+    """Generate: Set world_db[key] to int(val_string) if >= min and <= max."""
+    def func(val_string):
+        val = integer_test(val_string, min, max)
+        if val:
+            world_db[key] = val
+    return func
 
 
 def command_ping():
@@ -235,23 +314,240 @@ def command_quit():
     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)
+    # TODO: Test for existence of player thing and 'wait' thing action?
+
+
+def command_maplength(maplength_string):
+    # DUMMY.
+    set_world_inactive()
+    # TODO: remove things, map
+    worlddb_value_setter("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 command_ttid(id_string):
+    """Set ID of ThingType to manipulate. ID unused? Create new ThingType.
+
+    The ID of the ThingType to manipulate is stored as command_ttid.id. If
+    the integer of the input value is valid (>= -32768 and <= 32767), but <0 or
+    >255, a new ID is calculated: the lowest unused ID >=0 and <= 255.
+    """
+    id = integer_test(id_string, -32768, 32767)
+    if None != id:
+        if id in world_db["ThingTypes"]:
+            command_ttid.id = id
+        else:
+            if id < 0 or id > 255:
+                id = -1
+                while 1:
+                    id = id + 1
+                    if id not in world_db["ThingTypes"]:
+                        break
+                if id > 255:
+                    print("Ignoring: "
+                          "No unused ID available to add to ID list.")
+                    return
+            command_ttid.id = 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
+            }
+
+
+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
+
+
+test_ThingType_id = test_for_id_maker(command_ttid, "ThingType")
+
+
+def ThingType_value_setter(key, min, max):
+    """Build: Set selected ThingType's [key] to int(val_string) >=min/<=max."""
+    @test_ThingType_id
+    def f(val_string):
+        val = integer_test(val_string, min, max)
+        if None != val:
+            world_db["ThingTypes"][command_ttid.id][key] = val
+    return f
+
+
+@test_ThingType_id
+def command_ttname(name):
+    """Set to name TT_NAME of selected ThingType."""
+    world_db["ThingTypes"][command_ttid.id]["TT_NAME"] = name
+
+
+@test_ThingType_id
+def command_ttsymbol(char):
+    """Set to char 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 to int(str_int) 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("Corpse ID belongs to no known object type.")
+
+
+def command_taid(id_string):
+    """Set ID of ThingAction to manipulate. ID unused? Create new ThingAction.
+
+    The ID of the ThingAction to manipulate is stored as command_taid.id. If
+    the integer of the input value is valid (>= 0 and <= 255), but 0, a new ID
+    is calculated: The lowest unused ID >0 and <= 255.
+    """
+    id = integer_test(id_string, 0, 255)
+    if None != id:
+        if id in world_db["ThingActions"]:
+            command_taid.id = id
+        else:
+            if 0 == id:
+                while 1:
+                    id = id + 1
+                    if id not in world_db["ThingActions"]:
+                        break
+                if id > 255:
+                    print("Ignoring: "
+                          "No unused ID available to add to ID list.")
+                    return
+            command_taid.id = 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_taeffort(str_int):
+    """Set to int(str_int) TA_EFFORT of selected ThingAction."""
+    val = integer_test(str_int, 0, 255)
+    if None != val:
+        world_db["ThingActions"][command_taid.id]["TA_EFFORT"] = val
+
+
+@test_ThingAction_id
+def command_taname(name):
+    """Set to name 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]) 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),
+    "TA_ID": (1, False, command_taid),
+    "TA_EFFORT": (1, False, command_taeffort),
+    "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, ThingType_value_setter("TT_CONSUMABLE",
+                                                       0, 65535)),
+    "TT_START_NUMBER": (1, False, ThingType_value_setter("TT_START_NUMBER",
+                                                         0, 255)),
+    "TT_PROLIFERATE": (1, False, ThingType_value_setter("TT_PROLIFERATE",
+                                                        0, 255)),
+    "TT_LIFEPOINTS": (1, False, ThingType_value_setter("TT_LIFEPOINTS",
+                                                       0, 255))
 }
 
 
-"""World state database,"""
+"""World state database. With sane default values."""
 world_db = {
-    "turn": 0
+    "TURN": 1,
+    "SEED_MAP": 0,
+    "SEED_RANDOMNESS": 0,
+    "PLAYER_TYPE": 0,
+    "MAP_LENGTH": 64,
+    "WORLD_ACTIVE": 0,
+    "ThingActions": {},
+    "ThingTypes": {},
+    "Things": {}
 }